diff --git a/types/ably/ably-tests.ts b/types/ably/ably-tests.ts index 026ef48adc..bc50d03ce6 100644 --- a/types/ably/ably-tests.ts +++ b/types/ably/ably-tests.ts @@ -1,6 +1,6 @@ import * as Ably from 'ably'; -declare var console: { log(message: any): void }; +declare const console: { log(message: any): void }; const ApiKey = 'appId.keyId:secret'; const client = new Ably.Realtime(ApiKey); @@ -19,10 +19,9 @@ client.connection.on('failed', () => { // failed connection }); - // Subscribing to a channel -var channel = client.channels.get('test'); +const channel = client.channels.get('test'); channel.subscribe(message => { message.name; // 'greeting' message.data; // 'Hello World!' @@ -68,7 +67,6 @@ channel.history({ start: Date.now() - 10000, end: Date.now(), limit: 100, direct console.log(messagesPage.items.length); }); - // Presence on a channel // Getting presence: @@ -118,7 +116,7 @@ channel.history({ start: Date.now() - 10000, end: Date.now(), limit: 100, direct // Generate a random 256-bit key for demonstration purposes (in // practice you need to create one and distribute it to clients yourselves) Ably.Realtime.Crypto.generateRandomKey((err, key) => { - var channel = client.channels.get('channelName', { cipher: { key } }); + const channel = client.channels.get('channelName', { cipher: { key } }); channel.subscribe(message => { message.name; // 'name is not encrypted' @@ -136,7 +134,7 @@ channel.setOptions({cipher: {key: ''}}, () => { // Using the REST API -var restChannel = restClient.channels.get('test'); +const restChannel = restClient.channels.get('test'); // Publishing to a channel @@ -195,7 +193,6 @@ restChannel.presence.history((err, messagesPage) => { // PaginatedResult // Can optionally take an options param, see https://www.ably.io/documentation/rest-api/#message-history restChannel.history({ start: Date.now() - 10000, end: Date.now(), limit: 100, direction: 'forwards' }, (err, messagesPage) => {}); - // Generate Token and Token Request // See https://www.ably.io/documentation/general/authentication for an explanation of Ably's authentication mechanism. @@ -206,7 +203,7 @@ client.auth.requestToken((err, tokenDetails) => { // see https://www.ably.io/documentation/rest/authentication/#token-details for its properties // Now we have the token, we can send it to someone who can instantiate a client with it: - var clientUsingToken = new Ably.Realtime(tokenDetails.token); + const clientUsingToken = new Ably.Realtime(tokenDetails.token); }); // requestToken can take two optional params @@ -242,15 +239,15 @@ client.stats({ limit: 50 }, (err, statsPage) => { // statsPage as Paginat client.time({}, (err, time) => {}); // time is in ms since epoch // Getting decoded Message objects from JSON -var messages = Ably.Realtime.Message.fromEncodedArray([{ id: 'foo' }]); +const messages = Ably.Realtime.Message.fromEncodedArray([{ id: 'foo' }]); console.log(messages[0].id); -var message = Ably.Rest.Message.fromEncoded({ id: 'foo' }); +const message = Ably.Rest.Message.fromEncoded({ id: 'foo' }); console.log(message.id); // Getting decoded PresenceMessage objects from JSON -var presenceMessages = Ably.Realtime.PresenceMessage.fromEncodedArray([{ id: 'foo' }]); +const presenceMessages = Ably.Realtime.PresenceMessage.fromEncodedArray([{ id: 'foo' }]); console.log(presenceMessages[0].action); -var presenceMessage = Ably.Rest.PresenceMessage.fromEncoded({ id: 'foo' }); +const presenceMessage = Ably.Rest.PresenceMessage.fromEncoded({ id: 'foo' }); console.log(presenceMessage.action); diff --git a/types/ably/index.d.ts b/types/ably/index.d.ts index b8d1eb9bfe..7bfc2338b6 100644 --- a/types/ably/index.d.ts +++ b/types/ably/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Ably // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare namespace ablyLib { +export namespace ablyLib { namespace ChannelState { type INITIALIZED = 'initialized'; type ATTACHING = 'attaching'; @@ -130,15 +130,15 @@ declare namespace ablyLib { * A function which is called when a new token is required. * The role of the callback is to either generate a signed TokenRequest which may then be submitted automatically * by the library to the Ably REST API requestToken; or to provide a valid token in as a TokenDetails object. - **/ - authCallback?: (data: TokenParams, callback: (error: ErrorInfo | string, tokenRequestOrDetails: TokenDetails | TokenRequest | string) => void) => void; + */ + authCallback?(data: TokenParams, callback: (error: ErrorInfo | string, tokenRequestOrDetails: TokenDetails | TokenRequest | string) => void): void; authHeaders?: { [index: string]: string }; authMethod?: HTTPMethods; authParams?: { [index: string]: string }; /** * A URL that the library may use to obtain a token string (in plain text format), or a signed TokenRequest or TokenDetails (in JSON format). - **/ + */ authUrl?: string; key?: string; queryTime?: boolean; @@ -259,13 +259,13 @@ declare namespace ablyLib { /** * A number controlling the verbosity of the output. Valid values are: 0 (no logs), 1 (errors only), * 2 (errors plus connection and channel state changes), 3 (high-level debug output), and 4 (full debug output). - **/ + */ level?: number; /** * A function to handle each line of log output. If handler is not specified, console.log is used. - **/ - handler?: (...args: any[]) => void; + */ + handler?(...args: any[]): void; } interface ChannelEvent { @@ -398,7 +398,7 @@ declare namespace ablyLib { } interface Crypto { - generateRandomKey: (callback: (error: ErrorInfo, key: string) => void) => void; + generateRandomKey(callback: (error: ErrorInfo, key: string) => void): void; } class Connection extends EventEmitter { diff --git a/types/accounting/accounting-tests.ts b/types/accounting/accounting-tests.ts index 0c11683c65..a397c559eb 100644 --- a/types/accounting/accounting-tests.ts +++ b/types/accounting/accounting-tests.ts @@ -27,8 +27,6 @@ accounting.formatMoney(5318008, { // Will recursively format an array of values: accounting.formatMoney([123, 456, [78, 9]], "$", 0); // ["$123", "$456", ["$78", "$9"]] - - // formatColumn // Format list of numbers for display: @@ -40,8 +38,6 @@ accounting.formatColumn([123, 12345], "$ ", 0); // ["$ 123", "$ 12,345"] // List of numbers can be a multi-dimensional array (formatColumn is applied recursively): accounting.formatColumn([[1, 100], [900, 9]]); // [["$ 1.00", "$100.00"], ["$900.00", "$ 9.00"]] - - // formatNumber // Example usage: @@ -58,16 +54,11 @@ accounting.formatNumber(5318008, { // Will recursively format an array of values: accounting.formatNumber([123456, [7890, 123]]); // ["123,456", ["7,890", "123"]] - - // toFixed (0.615).toFixed(2); // "0.61" accounting.toFixed(0.615, 2); // "0.62" - - - // unformat // Example usage: diff --git a/types/adal/index.d.ts b/types/adal/index.d.ts index 18ca3d8079..552ca468aa 100644 --- a/types/adal/index.d.ts +++ b/types/adal/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for ADAL.JS 1.0.13 +// Type definitions for ADAL.JS 1.0.14 // Project: https://github.com/AzureAD/azure-activedirectory-library-for-js // Definitions by: mmaitre314 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -29,6 +29,7 @@ declare namespace adal { loginResource?: string; resource?: string; extraQueryParameter?: string; + navigateToLoginRequestUrl?: boolean; } interface User { diff --git a/types/amplify/amplify-tests.ts b/types/amplify/amplify-tests.ts index ab4a9bf1bd..62b00052dd 100644 --- a/types/amplify/amplify-tests.ts +++ b/types/amplify/amplify-tests.ts @@ -155,15 +155,11 @@ amplify.request("twitter-search", { term: "amplifyjs" } ); // Similarly, we can create a request that searches for mentions, by accepting a username: - amplify.request.define("twitter-mentions", "ajax", { - url: "http://search.twitter.com/search.json", - dataType: "jsonp", - dataMap: data => { - return { - q: "@" + data.user - }; - } - }); +amplify.request.define("twitter-mentions", "ajax", { + url: "http://search.twitter.com/search.json", + dataType: "jsonp", + dataMap: data => ({ q: "@" + data.user }), +}); amplify.request("twitter-mentions", { user: "amplifyjs" }); @@ -241,11 +237,11 @@ amplify.request({ // amplify.request comes with built in support for status.The status parameter appears in the default success or error callbacks when using an ajax definition. - amplify.request.define("statusExample1", "ajax", { - // ... - }); +amplify.request.define("statusExample1", "ajax", { + // ... +}); - amplify.request({ +amplify.request({ resourceId: "statusExample1", success: (data, status) => { }, diff --git a/types/amqplib/amqplib-tests.ts b/types/amqplib/amqplib-tests.ts index 24dade85dc..8bfcf3c9b4 100644 --- a/types/amqplib/amqplib-tests.ts +++ b/types/amqplib/amqplib-tests.ts @@ -1,7 +1,7 @@ // promise api tests import amqp = require('amqplib'); -var msg = 'Hello World'; +const msg = 'Hello World'; // test promise api amqp.connect('amqp://localhost') @@ -21,11 +21,10 @@ amqp.connect('amqp://localhost') }); // test promise api properties -var amqpMessage: amqp.Message; +let amqpMessage: amqp.Message; amqpMessage.properties.contentType = 'application/json'; -var amqpAssertExchangeOptions: amqp.Options.AssertExchange; -var anqpAssertExchangeReplies: amqp.Replies.AssertExchange; - +let amqpAssertExchangeOptions: amqp.Options.AssertExchange; +let anqpAssertExchangeReplies: amqp.Replies.AssertExchange; // callback api tests import amqpcb = require('amqplib/callback_api'); @@ -59,7 +58,7 @@ amqpcb.connect('amqp://localhost', (err, connection) => { }); // test callback api properties -var amqpcbMessage: amqpcb.Message; +let amqpcbMessage: amqpcb.Message; amqpcbMessage.properties.contentType = 'application/json'; -var amqpcbAssertExchangeOptions: amqpcb.Options.AssertExchange; -var anqpcbAssertExchangeReplies: amqpcb.Replies.AssertExchange; +let amqpcbAssertExchangeOptions: amqpcb.Options.AssertExchange; +let anqpcbAssertExchangeReplies: amqpcb.Replies.AssertExchange; diff --git a/types/angular/angular-tests.ts b/types/angular/angular-tests.ts index 637ebda708..53fd245f1d 100644 --- a/types/angular/angular-tests.ts +++ b/types/angular/angular-tests.ts @@ -820,8 +820,8 @@ angular.module('docsTimeDirective', []) .directive('myCurrentTime', ['$interval', 'dateFilter', ($interval: any, dateFilter: any) => { return { link(scope: ng.IScope, element: ng.IAugmentedJQuery, attrs: ng.IAttributes) { - let format: any, - timeoutId: any; + let format: any; + let timeoutId: any; function updateTime() { element.text(dateFilter(new Date(), format)); @@ -896,7 +896,10 @@ angular.module('docsIsoFnBindExample', []) angular.module('dragModule', []) .directive('myDraggable', ['$document', ($document: any) => { return (scope: any, element: any, attr: any) => { - let startX = 0, startY = 0, x = 0, y = 0; + let startX = 0; + let startY = 0; + let x = 0; + let y = 0; element.css({ position: 'relative', diff --git a/types/angular/index.d.ts b/types/angular/index.d.ts index 6ff43a5290..727944fbb1 100644 --- a/types/angular/index.d.ts +++ b/types/angular/index.d.ts @@ -413,7 +413,7 @@ declare namespace angular { // https://docs.angularjs.org/api/ng/directive/ngModelOptions interface INgModelOptions { updateOn?: string; - debounce?: any; + debounce?: number | { [key: string]: number; }; allowInvalid?: boolean; getterSetter?: boolean; timezone?: string; @@ -602,7 +602,7 @@ declare namespace angular { /////////////////////////////////////////////////////////////////////////// interface ITimeoutService { (delay?: number, invokeApply?: boolean): IPromise; - (fn: (...args: any[]) => T, delay?: number, invokeApply?: boolean, ...args: any[]): IPromise; + (fn: (...args: any[]) => T | IPromise, delay?: number, invokeApply?: boolean, ...args: any[]): IPromise; cancel(promise?: IPromise): boolean; } @@ -875,7 +875,8 @@ declare namespace angular { * @param identifierStart The function that will decide whether the given character is a valid identifier start character. * @param identifierContinue The function that will decide whether the given character is a valid identifier continue character. **/ - setIdentifierFns(identifierStart?: (character: string, codePoint: number) => boolean, + setIdentifierFns( + identifierStart?: (character: string, codePoint: number) => boolean, identifierContinue?: (character: string, codePoint: number) => boolean): void; } diff --git a/types/angular/tslint.json b/types/angular/tslint.json index 196218148d..057f35a770 100644 --- a/types/angular/tslint.json +++ b/types/angular/tslint.json @@ -6,11 +6,13 @@ "quotemark": [true, "single"], "variable-name": [true, "check-format"], + // Below are all TODOs "callable-types": false, "ban-types": false, "interface-name": false, - "no-empty-interface": false, + "jsdoc-format": false, "max-line-length": false, + "no-empty-interface": false, "unified-signatures": false, "void-return": false } diff --git a/types/applepayjs/applepayjs-tests.ts b/types/applepayjs/applepayjs-tests.ts index 26c61396ae..5adf61e45c 100644 --- a/types/applepayjs/applepayjs-tests.ts +++ b/types/applepayjs/applepayjs-tests.ts @@ -21,7 +21,6 @@ describe("ApplePaySession", () => { } }); it("can create a new instance", () => { - const version = 1; const paymentRequest = { countryCode: "US", @@ -42,7 +41,6 @@ describe("ApplePaySession", () => { const session = new ApplePaySession(version, paymentRequest); }); it("can call static methods", () => { - const merchantIdentifier = "MyMerchantId"; let canMakePayments: boolean = ApplePaySession.canMakePayments(); @@ -59,7 +57,6 @@ describe("ApplePaySession", () => { }); }); it("can call instance methods", () => { - const version = 1; const paymentRequest = { countryCode: "US", @@ -171,7 +168,6 @@ describe("ApplePaySession", () => { }); describe("ApplePayPaymentRequest", () => { it("can create a new instance", () => { - let paymentRequest: ApplePayJS.ApplePayPaymentRequest = { applicationData: "ApplicationData", countryCode: "GB", diff --git a/types/applepayjs/index.d.ts b/types/applepayjs/index.d.ts index 52af393ebd..744e1fd044 100644 --- a/types/applepayjs/index.d.ts +++ b/types/applepayjs/index.d.ts @@ -7,7 +7,6 @@ * A session object for managing the payment process on the web. */ declare class ApplePaySession extends EventTarget { - /** * Creates a new instance of the ApplePaySession class. * @param version - The version of the ApplePay JS API you are using. @@ -164,12 +163,10 @@ declare class ApplePaySession extends EventTarget { } declare namespace ApplePayJS { - /** * Defines a line item in a payment request - for example, total, tax, discount, or grand total. */ interface ApplePayLineItem { - /** * A short, localized description of the line item. */ @@ -190,7 +187,6 @@ declare namespace ApplePayJS { * Represents the result of authorizing a payment request and contains encrypted payment information. */ interface ApplePayPayment { - /** * The encrypted token for an authorized payment. */ @@ -211,7 +207,6 @@ declare namespace ApplePayJS { * The Apple​Pay​Payment​Authorized​Event class defines the attributes contained by the ApplePaySession.onpaymentauthorized callback function. */ abstract class ApplePayPaymentAuthorizedEvent extends Event { - /** * The payment token used to authorize a payment. */ @@ -222,7 +217,6 @@ declare namespace ApplePayJS { * Encapsulates contact information needed for billing and shipping. */ interface ApplePayPaymentContact { - /** * An email address for the contact. */ @@ -278,7 +272,6 @@ declare namespace ApplePayJS { * Contains information about an Apple Pay payment card. */ interface ApplePayPaymentMethod { - /** * A string, suitable for display, that describes the card. */ @@ -305,7 +298,6 @@ declare namespace ApplePayJS { * The Apple​Pay​Payment​Method​Selected​Event class defines the attributes contained by the ApplePaySession.onpaymentmethodselected callback function. */ abstract class ApplePayPaymentMethodSelectedEvent extends Event { - /** * The card used to complete a payment. */ @@ -316,7 +308,6 @@ declare namespace ApplePayJS { * Represents a provisioned payment card for Apple Pay payments. */ interface ApplePayPaymentPass { - /** * The unique identifier for the primary account number for the payment card. */ @@ -347,7 +338,6 @@ declare namespace ApplePayJS { * Encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information. */ interface ApplePayPaymentRequest { - /** * The merchant's two-letter ISO 3166 country code. */ @@ -419,7 +409,6 @@ declare namespace ApplePayJS { * Contains the user's payment credentials. */ interface ApplePayPaymentToken { - /** * An object containing the encrypted payment data. */ @@ -440,7 +429,6 @@ declare namespace ApplePayJS { * The Apple​Pay​Shipping​Contact​Selected​Event class defines the attributes contained by the ApplePaySession.onshippingcontactselected callback function. */ abstract class ApplePayShippingContactSelectedEvent extends Event { - /** * The shipping address selected by the user. */ @@ -451,7 +439,6 @@ declare namespace ApplePayJS { * Defines a shipping method for delivering physical goods. */ interface ApplePayShippingMethod { - /** * A short description of the shipping method. */ @@ -477,7 +464,6 @@ declare namespace ApplePayJS { * The Apple​Pay​Shipping​Method​Selected​Event class defines the attribute contained by the ApplePaySession.onshippingmethodselected callback function. */ abstract class ApplePayShippingMethodSelectedEvent extends Event { - /** * The shipping method selected by the user. */ @@ -488,7 +474,6 @@ declare namespace ApplePayJS { * The Apple​Pay​Validate​Merchant​Event class defines the attributes contained by the ApplePaySession.onvalidatemerchant callback function. */ abstract class ApplePayValidateMerchantEvent extends Event { - /** * The URL used to validate the merchant server. */ @@ -496,7 +481,6 @@ declare namespace ApplePayJS { } abstract class Event { - readonly bubbles: boolean; cancelBubble: boolean; diff --git a/types/applepayjs/tslint.json b/types/applepayjs/tslint.json index 0344a1a3fa..377cc837d4 100644 --- a/types/applepayjs/tslint.json +++ b/types/applepayjs/tslint.json @@ -1,3 +1 @@ -{ - "extends": "../tslint.json" -} +{ "extends": "../tslint.json" } diff --git a/types/applicationinsights-js/applicationinsights-js-tests.ts b/types/applicationinsights-js/applicationinsights-js-tests.ts index 66bc1f268d..1a4d585795 100644 --- a/types/applicationinsights-js/applicationinsights-js-tests.ts +++ b/types/applicationinsights-js/applicationinsights-js-tests.ts @@ -1,6 +1,6 @@ // More samples on: https://github.com/Microsoft/ApplicationInsights-JS/blob/master/API-reference.md -var config: Microsoft.ApplicationInsights.IConfig = { +const config: Microsoft.ApplicationInsights.IConfig = { instrumentationKey: "", endpointUrl: "endpointUrl", emitLineDelimitedJson: false, @@ -30,7 +30,7 @@ var config: Microsoft.ApplicationInsights.IConfig = { isStorageUseDisabled: true }; -var appInsights: Microsoft.ApplicationInsights.IAppInsights = { +appInsights = { config, context: null, queue: null, @@ -91,9 +91,8 @@ appInsights.setAuthenticatedUserContext("userId", "accountId"); // set config dynamically appInsights.config.instrumentationKey = ""; - // TelementryContext -var context: Microsoft.ApplicationInsights.ITelemetryContext = appInsights.context; +const context: Microsoft.ApplicationInsights.ITelemetryContext = appInsights.context; context.application.ver = "v0.0.0"; context.application.build = "1.1.1"; @@ -113,54 +112,54 @@ context.operation.id = "1"; context.operation.syntheticSource = "testAgent"; // track -var data = new Microsoft.Telemetry.Base(); -var envelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(data, "name"); +const data = new Microsoft.Telemetry.Base(); +const envelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(data, "name"); context.track(envelope); -context.addTelemetryInitializer((envelope) => false); +context.addTelemetryInitializer(telemetryEnvelope => false); // track event -var eventObj = new Microsoft.ApplicationInsights.Telemetry.Event("test", null, null); -var eventData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Event.dataType, eventObj); -var eventEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(eventData, Microsoft.ApplicationInsights.Telemetry.Event.envelopeType); +const eventObj = new Microsoft.ApplicationInsights.Telemetry.Event("test", null, null); +const eventData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Event.dataType, eventObj); +const eventEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(eventData, Microsoft.ApplicationInsights.Telemetry.Event.envelopeType); context.track(eventEnvelope); // track exception -var exceptionObj = new Microsoft.ApplicationInsights.Telemetry.Exception(new Error(), "handledAt", null, null, AI.SeverityLevel.Critical); -var exceptionData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( +const exceptionObj = new Microsoft.ApplicationInsights.Telemetry.Exception(new Error(), "handledAt", null, null, AI.SeverityLevel.Critical); +const exceptionData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( Microsoft.ApplicationInsights.Telemetry.Exception.dataType, exceptionObj); -var exceptionEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(exceptionData, Microsoft.ApplicationInsights.Telemetry.Exception.envelopeType); +const exceptionEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(exceptionData, Microsoft.ApplicationInsights.Telemetry.Exception.envelopeType); context.track(exceptionEnvelope); // track metric -var metricObj = new Microsoft.ApplicationInsights.Telemetry.Metric("name", 1234, 1, 0, 100, null); -var metricData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Metric.dataType, metricObj); -var metricEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(metricData, Microsoft.ApplicationInsights.Telemetry.Metric.envelopeType); +const metricObj = new Microsoft.ApplicationInsights.Telemetry.Metric("name", 1234, 1, 0, 100, null); +const metricData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Metric.dataType, metricObj); +const metricEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(metricData, Microsoft.ApplicationInsights.Telemetry.Metric.envelopeType); context.track(metricEnvelope); // track page view -var pageViewObj = new Microsoft.ApplicationInsights.Telemetry.PageView("page name", "url", 999, null, null); -var pageViewData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.PageView.dataType, pageViewObj); -var pageViewEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(pageViewData, Microsoft.ApplicationInsights.Telemetry.PageView.envelopeType); +const pageViewObj = new Microsoft.ApplicationInsights.Telemetry.PageView("page name", "url", 999, null, null); +const pageViewData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.PageView.dataType, pageViewObj); +const pageViewEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(pageViewData, Microsoft.ApplicationInsights.Telemetry.PageView.envelopeType); context.track(pageViewEnvelope); // track page view performance -var pageViewPerfObj = new Microsoft.ApplicationInsights.Telemetry.PageViewPerformance("page name", "url", 999, null, null); -var pageViewPerfData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( +const pageViewPerfObj = new Microsoft.ApplicationInsights.Telemetry.PageViewPerformance("page name", "url", 999, null, null); +const pageViewPerfData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( Microsoft.ApplicationInsights.Telemetry.PageViewPerformance.dataType, pageViewPerfObj); -var pageViewPerfEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(pageViewPerfData, Microsoft.ApplicationInsights.Telemetry.PageViewPerformance.envelopeType); +const pageViewPerfEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(pageViewPerfData, Microsoft.ApplicationInsights.Telemetry.PageViewPerformance.envelopeType); context.track(pageViewPerfEnvelope); // track remote dependency -var remoteDepObj = new Microsoft.ApplicationInsights.Telemetry.RemoteDependencyData("id", "url", "command", 1, true, 1234, "GET"); -var remoteDepData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( +const remoteDepObj = new Microsoft.ApplicationInsights.Telemetry.RemoteDependencyData("id", "url", "command", 1, true, 1234, "GET"); +const remoteDepData = new Microsoft.ApplicationInsights.Telemetry.Common.Data( Microsoft.ApplicationInsights.Telemetry.RemoteDependencyData.dataType, remoteDepObj); -var remoteDepEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(remoteDepData, Microsoft.ApplicationInsights.Telemetry.RemoteDependencyData.envelopeType); +const remoteDepEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(remoteDepData, Microsoft.ApplicationInsights.Telemetry.RemoteDependencyData.envelopeType); context.track(pageViewPerfEnvelope); // track trace -var traceObj = new Microsoft.ApplicationInsights.Telemetry.Trace("message", null); -var traceData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Trace.dataType, traceObj); -var traceEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(traceData, Microsoft.ApplicationInsights.Telemetry.Trace.envelopeType); -context.track(traceEnvelope); \ No newline at end of file +const traceObj = new Microsoft.ApplicationInsights.Telemetry.Trace("message", null); +const traceData = new Microsoft.ApplicationInsights.Telemetry.Common.Data(Microsoft.ApplicationInsights.Telemetry.Trace.dataType, traceObj); +const traceEnvelope = new Microsoft.ApplicationInsights.Telemetry.Common.Envelope(traceData, Microsoft.ApplicationInsights.Telemetry.Trace.envelopeType); +context.track(traceEnvelope); diff --git a/types/applicationinsights-js/index.d.ts b/types/applicationinsights-js/index.d.ts index ede1584bb5..cce53f5823 100644 --- a/types/applicationinsights-js/index.d.ts +++ b/types/applicationinsights-js/index.d.ts @@ -195,8 +195,8 @@ declare module Microsoft.ApplicationInsights.Context { interface IInternal { /** - * The SDK version used to create this telemetry item. - */ + * The SDK version used to create this telemetry item. + */ sdkVersion: string; /** * The SDK agent version. @@ -206,15 +206,15 @@ declare module Microsoft.ApplicationInsights.Context { interface ISample { /** - * Sample rate - */ + * Sample rate + */ sampleRate: number; } interface ISession { /** - * The session ID. - */ + * The session ID. + */ id: string; /** * The true if this is the first session @@ -258,8 +258,8 @@ declare module Microsoft.ApplicationInsights.Context { interface IUser { /** - * The telemetry configuration. - */ + * The telemetry configuration. + */ config: any; /** * The user ID. @@ -345,12 +345,12 @@ declare module Microsoft.ApplicationInsights.Telemetry { measurements: Microsoft.ApplicationInsights.FieldType; }; /** - * Constructs a new isntance of the ExceptionTelemetry object - */ + * Constructs a new isntance of the ExceptionTelemetry object + */ constructor(exception: Error, handledAt?: string, properties?: any, measurements?: any, severityLevel?: AI.SeverityLevel); /** - * Creates a simple exception with 1 stack frame. Useful for manual constracting of exception. - */ + * Creates a simple exception with 1 stack frame. Useful for manual constracting of exception. + */ static CreateSimpleException(message: string, typeName: string, assembly: string, fileName: string, details: string, line: number, handledAt?: string): Telemetry.Exception; } @@ -414,8 +414,8 @@ declare module Microsoft.ApplicationInsights.Telemetry { getIsValid(): boolean; private durationMs; /** - * Gets the total duration (PLT) in milliseconds. Check getIsValid() before using this method. - */ + * Gets the total duration (PLT) in milliseconds. Check getIsValid() before using this method. + */ getDurationMs(): number; /** * Constructs a new instance of the PageEventTelemetry object @@ -423,8 +423,8 @@ declare module Microsoft.ApplicationInsights.Telemetry { constructor(name: string, url: string, unused: number, properties?: any, measurements?: any); static getPerformanceTiming(): PerformanceTiming; /** - * Returns true is window performance timing API is supported, false otherwise. - */ + * Returns true is window performance timing API is supported, false otherwise. + */ static isPerformanceTimingSupported(): PerformanceTiming; /** * As page loads different parts of performance timing numbers get set. When all of them are set we can report it. @@ -615,16 +615,16 @@ declare module Microsoft.ApplicationInsights { interface ITelemetryContext { /** - * The object describing a component tracked by this object. - */ + * The object describing a component tracked by this object. + */ application: Context.IApplication; /** * The object describing a device tracked by this object. */ device: Context.IDevice; /** - * The object describing internal settings. - */ + * The object describing internal settings. + */ internal: Context.IInternal; /** * The object describing a location tracked by this object. @@ -635,8 +635,8 @@ declare module Microsoft.ApplicationInsights { */ operation: Context.IOperation; /** - * The object describing sampling settings. - */ + * The object describing sampling settings. + */ sample: Context.ISample; /** * The object describing a user tracked by this object. @@ -647,13 +647,13 @@ declare module Microsoft.ApplicationInsights { */ session: Context.ISession; /** - * Adds telemetry initializer to the collection. Telemetry initializers will be called one by one - * before telemetry item is pushed for sending and in the order they were added. - */ + * Adds telemetry initializer to the collection. Telemetry initializers will be called one by one + * before telemetry item is pushed for sending and in the order they were added. + */ addTelemetryInitializer(telemetryInitializer: (envelope: Microsoft.ApplicationInsights.IEnvelope) => boolean): any; /** - * Tracks telemetry object. - */ + * Tracks telemetry object. + */ track(envelope: Microsoft.ApplicationInsights.IEnvelope): any; } @@ -662,23 +662,23 @@ declare module Microsoft.ApplicationInsights { context: ITelemetryContext; queue: Array<() => void>; /** - * Starts timing how long the user views a page or other item. Call this when the page opens. - * This method doesn't send any telemetry. Call {@link stopTrackTelemetry} to log the page when it closes. - * @param name A string that idenfities this item, unique within this HTML document. Defaults to the document title. - */ + * Starts timing how long the user views a page or other item. Call this when the page opens. + * This method doesn't send any telemetry. Call {@link stopTrackTelemetry} to log the page when it closes. + * @param name A string that idenfities this item, unique within this HTML document. Defaults to the document title. + */ startTrackPage(name?: string): any; /** - * Logs how long a page or other item was visible, after {@link startTrackPage}. Call this when the page closes. - * @param name The string you used as the name in startTrackPage. Defaults to the document title. - * @param url String - a relative or absolute URL that identifies the page or other item. Defaults to the window location. - * @param properties map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty. - * @param measurements map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty. - */ - stopTrackPage(name?: string, url?: string, properties?: { - [name: string]: string; - }, measurements?: { - [name: string]: number; - }): any; + * Logs how long a page or other item was visible, after {@link startTrackPage}. Call this when the page closes. + * @param name The string you used as the name in startTrackPage. Defaults to the document title. + * @param url String - a relative or absolute URL that identifies the page or other item. Defaults to the window location. + * @param properties map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty. + * @param measurements map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty. + */ + stopTrackPage( + name?: string, + url?: string, + properties?: { [name: string]: string }, + measurements?: { [name: string]: number }): any; /** * Logs that a page or other item was viewed. * @param name The string you used as the name in startTrackPage. Defaults to the document title. @@ -687,11 +687,11 @@ declare module Microsoft.ApplicationInsights { * @param measurements map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty. * @param duration number - the number of milliseconds it took to load the page. Defaults to undefined. If set to default value, page load time is calculated internally. */ - trackPageView(name?: string, url?: string, properties?: { - [name: string]: string; - }, measurements?: { - [name: string]: number; - }, duration?: number): any; + trackPageView( + name?: string, + url?: string, + properties?: { [name: string]: string }, + measurements?: { [name: string]: number }, duration?: number): any; /** * Start timing an extended event. Call {@link stopTrackEvent} to log the event when it ends. * @param name A string that identifies this event uniquely within the document. @@ -703,22 +703,20 @@ declare module Microsoft.ApplicationInsights { * @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty. * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. */ - stopTrackEvent(name: string, properties?: { - [name: string]: string; - }, measurements?: { - [name: string]: number; - }): any; + stopTrackEvent( + name: string, + properties?: { [name: string]: string }, + measurements?: { [name: string]: number }): any; /** - * Log a user action or other occurrence. - * @param name A string to identify this event in the portal. - * @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty. - * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. - */ - trackEvent(name: string, properties?: { - [name: string]: string; - }, measurements?: { - [name: string]: number; - }): any; + * Log a user action or other occurrence. + * @param name A string to identify this event in the portal. + * @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty. + * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. + */ + trackEvent( + name: string, + properties?: { [name: string]: string }, + measurements?: { [name: string]: number }): any; /** * Log a dependency call * @param id unique id, this is used by the backend o correlate server requests. Use Util.newId() to generate a unique Id. @@ -737,11 +735,12 @@ declare module Microsoft.ApplicationInsights { * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. * @param severityLevel AI.SeverityLevel - severity level */ - trackException(exception: Error, handledAt?: string, properties?: { - [name: string]: string; - }, measurements?: { - [name: string]: number; - }, severityLevel?: AI.SeverityLevel): any; + trackException( + exception: Error, + handledAt?: string, + properties?: { [name: string]: string }, + measurements?: { [name: string]: number }, + severityLevel?: AI.SeverityLevel): any; /** * Log a numeric value that is not associated with a specific event. Typically used to send regular reports of performance indicators. * To send a single measurement, use just the first two parameters. If you take measurements very frequently, you can reduce the @@ -752,28 +751,30 @@ declare module Microsoft.ApplicationInsights { * @param min The smallest measurement in the sample. Defaults to the average. * @param max The largest measurement in the sample. Defaults to the average. */ - trackMetric(name: string, average: number, sampleCount?: number, min?: number, max?: number, properties?: { - [name: string]: string; - }): any; + trackMetric( + name: string, + average: number, + sampleCount?: number, + min?: number, + max?: number, + properties?: { [name: string]: string }): any; /** - * Log a diagnostic message. - * @param message A message string - * @param properties map[string, string] - additional data used to filter traces in the portal. Defaults to empty. - */ - trackTrace(message: string, properties?: { - [name: string]: string; - }): any; + * Log a diagnostic message. + * @param message A message string + * @param properties map[string, string] - additional data used to filter traces in the portal. Defaults to empty. + */ + trackTrace(message: string, properties?: { [name: string]: string }): any; /** * Immediately send all queued telemetry. */ flush(): any; /** - * Sets the autheticated user id and the account id in this session. - * User auth id and account id should be of type string. They should not contain commas, semi-colons, equal signs, spaces, or vertical-bars. - * - * @param authenticatedUserId {string} - The authenticated user id. A unique and persistent string that represents each authenticated user in the service. - * @param accountId {string} - An optional string to represent the account associated with the authenticated user. - */ + * Sets the autheticated user id and the account id in this session. + * User auth id and account id should be of type string. They should not contain commas, semi-colons, equal signs, spaces, or vertical-bars. + * + * @param authenticatedUserId {string} - The authenticated user id. A unique and persistent string that represents each authenticated user in the service. + * @param accountId {string} - An optional string to represent the account associated with the authenticated user. + */ setAuthenticatedUserContext(authenticatedUserId: string, accountId?: string): any; /** * Clears the authenticated user id and the account id from the user context. @@ -796,4 +797,4 @@ declare module 'applicationinsights-js' { const AppInsights: Microsoft.ApplicationInsights.IAppInsights; } -declare var appInsights: Microsoft.ApplicationInsights.IAppInsights; \ No newline at end of file +declare var appInsights: Microsoft.ApplicationInsights.IAppInsights; diff --git a/types/arcgis-rest-api/arcgis-rest-api-tests.ts b/types/arcgis-rest-api/arcgis-rest-api-tests.ts index 0f4cf3d926..3955b02f35 100644 --- a/types/arcgis-rest-api/arcgis-rest-api-tests.ts +++ b/types/arcgis-rest-api/arcgis-rest-api-tests.ts @@ -8,4 +8,4 @@ point = { spatialReference: { wkid: 4326 } -}; \ No newline at end of file +}; diff --git a/types/arcgis-rest-api/index.d.ts b/types/arcgis-rest-api/index.d.ts index 65a02a4367..0992772fec 100644 --- a/types/arcgis-rest-api/index.d.ts +++ b/types/arcgis-rest-api/index.d.ts @@ -65,7 +65,6 @@ export interface BezierCurve { export type JsonCurve = CircularArc | Arc | OldCircularArc | BezierCurve; - export interface SpatialReferenceWkid { wkid?: number; latestWkid?: number; @@ -131,7 +130,6 @@ export interface Envelope extends Geometry { export type esriGeometryType = "esriGeometryPoint" | "esriGeometryMultipoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | "esriGeometryEnvelope"; - export type Color = [number, number, number, number]; export type SimpleMarkerSymbolStyle = "esriSMSCircle" | "esriSMSCross" | "esriSMSDiamond" | "esriSMSSquare" | "esriSMSX" | "esriSMSTriangle"; export type SimpleLineSymbolStyle = "esriSLSDash" | "esriSLSDashDot" | "esriSLSDashDotDot" | "esriSLSDot" | "esriSLSNull" | "esriSLSSolid"; @@ -181,7 +179,6 @@ export interface PictureSourced { "angle"?: number; "xoffset"?: number; "yoffset"?: number; - } export interface PictureMarkerSymbol extends MarkerSymbol, PictureSourced { @@ -217,4 +214,4 @@ export interface TextSymbol extends MarkerSymbol { "kerning"?: boolean; "font"?: Font; "text"?: string; // only applicable when specified as a client-side graphic. -} \ No newline at end of file +} diff --git a/types/arcgis-to-geojson-utils/arcgis-to-geojson-utils-tests.ts b/types/arcgis-to-geojson-utils/arcgis-to-geojson-utils-tests.ts index 2e9337793a..5cb9d9472e 100644 --- a/types/arcgis-to-geojson-utils/arcgis-to-geojson-utils-tests.ts +++ b/types/arcgis-to-geojson-utils/arcgis-to-geojson-utils-tests.ts @@ -14,7 +14,7 @@ const geojsonPoint: GeoJSON.Point = { }; // parse ArcGIS JSON, convert it to GeoJSON -var geojson = utils.arcgisToGeoJSON(arcgisPoint); +const geojson = utils.arcgisToGeoJSON(arcgisPoint); // take GeoJSON and convert it to ArcGIS JSON -var arcgis = utils.geojsonToArcGIS(geojsonPoint); \ No newline at end of file +const arcgis = utils.geojsonToArcGIS(geojsonPoint); diff --git a/types/arcgis-to-geojson-utils/index.d.ts b/types/arcgis-to-geojson-utils/index.d.ts index 94a86022a3..65c78a4230 100644 --- a/types/arcgis-to-geojson-utils/index.d.ts +++ b/types/arcgis-to-geojson-utils/index.d.ts @@ -15,4 +15,4 @@ export function arcgisToGeoJSON(arcgis: T): GeoJSON.G /** * Converts a GeoJSON geometry into a ArcGIS geometry. */ -export function geojsonToArcGIS(geojson: GeoJSON.GeometryObject): ArcGis.Geometry; \ No newline at end of file +export function geojsonToArcGIS(geojson: GeoJSON.GeometryObject): ArcGis.Geometry; diff --git a/types/array-uniq/array-uniq-tests.ts b/types/array-uniq/array-uniq-tests.ts index 8674d2508c..b6c90c620a 100644 --- a/types/array-uniq/array-uniq-tests.ts +++ b/types/array-uniq/array-uniq-tests.ts @@ -2,4 +2,4 @@ import arrayUniq = require("array-uniq"); arrayUniq([1, 1, 2, 3, 3]); -arrayUniq(["foo", "foo", "bar", "foo"]); \ No newline at end of file +arrayUniq(["foo", "foo", "bar", "foo"]); diff --git a/types/array-uniq/index.d.ts b/types/array-uniq/index.d.ts index 25d97c0a94..d05ad76072 100644 --- a/types/array-uniq/index.d.ts +++ b/types/array-uniq/index.d.ts @@ -5,4 +5,4 @@ declare function arrayUniq(arr: T[]): T[]; -export = arrayUniq; \ No newline at end of file +export = arrayUniq; diff --git a/types/artyom.js/artyom.js-tests.ts b/types/artyom.js/artyom.js-tests.ts index 67e5908883..d301c9a6f4 100644 --- a/types/artyom.js/artyom.js-tests.ts +++ b/types/artyom.js/artyom.js-tests.ts @@ -29,4 +29,4 @@ artyom.getVoices(); artyom.getLanguage(); // Get the artyom.js version -artyom.getVersion(); \ No newline at end of file +artyom.getVersion(); diff --git a/types/artyom.js/index.d.ts b/types/artyom.js/index.d.ts index ae120015ca..b4f85781c6 100644 --- a/types/artyom.js/index.d.ts +++ b/types/artyom.js/index.d.ts @@ -22,16 +22,16 @@ interface SpeechRecognition extends EventTarget { start(): void; stop(): void; abort(): void; - onaudiostart: (ev: Event) => any; - onsoundstart: (ev: Event) => any; - onspeechstart: (ev: Event) => any; - onspeechend: (ev: Event) => any; - onsoundend: (ev: Event) => any; - onresult: (ev: SpeechRecognitionEvent) => any; - onnomatch: (ev: SpeechRecognitionEvent) => any; - onerror: (ev: SpeechRecognitionError) => any; - onstart: (ev: Event) => any; - onend: (ev: Event) => any; + onaudiostart(ev: Event): any; + onsoundstart(ev: Event): any; + onspeechstart(ev: Event): any; + onspeechend(ev: Event): any; + onsoundend(ev: Event): any; + onresult(ev: SpeechRecognitionEvent): any; + onnomatch(ev: SpeechRecognitionEvent): any; + onerror(ev: SpeechRecognitionError): any; + onstart(ev: Event): any; + onend(ev: Event): any; } interface SpeechRecognitionStatic { @@ -106,7 +106,7 @@ interface SpeechSynthesis extends EventTarget { speaking: boolean; paused: boolean; - onvoiceschanged: (ev: Event) => any; + onvoiceschanged(ev: Event): any; speak(utterance: SpeechSynthesisUtterance): void; cancel(): void; pause(): void; @@ -128,13 +128,13 @@ interface SpeechSynthesisUtterance extends EventTarget { rate: number; pitch: number; - onstart: (ev: SpeechSynthesisEvent) => any; - onend: (ev: SpeechSynthesisEvent) => any; - onerror: (ev: SpeechSynthesisErrorEvent) => any; - onpause: (ev: SpeechSynthesisEvent) => any; - onresume: (ev: SpeechSynthesisEvent) => any; - onmark: (ev: SpeechSynthesisEvent) => any; - onboundary: (ev: SpeechSynthesisEvent) => any; + onstart(ev: SpeechSynthesisEvent): any; + onend(ev: SpeechSynthesisEvent): any; + onerror(ev: SpeechSynthesisErrorEvent): any; + onpause(ev: SpeechSynthesisEvent): any; + onresume(ev: SpeechSynthesisEvent): any; + onmark(ev: SpeechSynthesisEvent): any; + onboundary(ev: SpeechSynthesisEvent): any; } interface SpeechSynthesisUtteranceStatic { @@ -211,7 +211,7 @@ declare namespace Artyom { /** Triggers of the command */ indexes: string[]; /** Logic to execute when the command is triggered */ - action: (i: number, wildcard?: string, full?: string) => void; + action(i: number, wildcard?: string, full?: string): void; /** Description of the command */ description?: string; /** Flag to specify is a command is either normal or smart */ @@ -502,7 +502,7 @@ declare namespace Artyom { /** * Method to bla, bla, bla... */ - static getInstance(): ArtyomJS + static getInstance(): ArtyomJS; } } diff --git a/types/assert-plus/index.d.ts b/types/assert-plus/index.d.ts index 5de187cb85..d79172bc49 100644 --- a/types/assert-plus/index.d.ts +++ b/types/assert-plus/index.d.ts @@ -122,7 +122,6 @@ export function AssertionError(options: any, message ?: string): void; */ export function fail(actual: any, expected: any, message: any, operator: any): void; - /** * Tests if `value` is truthy. It is equivalent to `assert.equal(!!value, true, message)`. * @@ -353,5 +352,4 @@ export function doesNotThrow(block: any, error ?: any, message ?: string): void; */ export function ifError(value: any): void; - export as namespace AssertPlus; diff --git a/types/awesomplete/awesomplete-tests.ts b/types/awesomplete/awesomplete-tests.ts index 5a33aeb135..6cea0e1bca 100644 --- a/types/awesomplete/awesomplete-tests.ts +++ b/types/awesomplete/awesomplete-tests.ts @@ -1,6 +1,6 @@ import * as Awesomplete from 'awesomplete'; -var input = document.getElementById("myinput"); +const input = document.getElementById("myinput"); new Awesomplete(input, {list: "#mylist"}); new Awesomplete(input, {list: document.querySelector("#mylist")}); @@ -9,7 +9,7 @@ new Awesomplete(input, { list: ["Ada", "Java", "JavaScript", "LOLCODE", "Node.js", "Ruby on Rails"] }); -var awesomplete = new Awesomplete(input); +const awesomplete = new Awesomplete(input); awesomplete.list = ["Ada", "Java", "JavaScript", "LOLCODE", "Node.js", "Ruby on Rails"]; new Awesomplete(input, { @@ -46,15 +46,15 @@ new Awesomplete('input[data-multiple]', { }, replace: (text: string) => { - var before = this.input.value.match(/^.+,\s*|/)[0]; + const before = this.input.value.match(/^.+,\s*|/)[0]; this.input.value = before + text + ", "; } }); -var ajax = new XMLHttpRequest(); +const ajax = new XMLHttpRequest(); ajax.open("GET", "https://restcountries.eu/rest/v1/lang/fr", true); ajax.onload = () => { - var list = JSON.parse(ajax.responseText).map((i: any) => i.name); + const list = JSON.parse(ajax.responseText).map((i: any) => i.name); new Awesomplete(document.querySelector("#ajax-example input"), { list }); }; ajax.send(); diff --git a/types/awesomplete/index.d.ts b/types/awesomplete/index.d.ts index 41abc36be6..4612d66210 100644 --- a/types/awesomplete/index.d.ts +++ b/types/awesomplete/index.d.ts @@ -6,14 +6,14 @@ declare class Awesomplete { constructor(input: Element | HTMLElement | string, o?: Awesomplete.Options); static all: any[]; - static $$: (expr: string | NodeSelector, con?: any) => NodeList; + static $$(expr: string | NodeSelector, con?: any): NodeList; static ITEM: (text: string, input: string) => HTMLElement; static $: { (expr: string|Element, con?: NodeSelector): string | Element; - regExpEscape: (s: { replace: (arg0: RegExp, arg1: string) => void }) => any; - create: (tag: string, o: any) => HTMLElement; - fire: (target: EventTarget, type: string, properties: any) => any; - siblingIndex: (el: Element) => number; + regExpEscape(s: { replace(arg0: RegExp, arg1: string): void }): any; + create(tag: string, o: any): HTMLElement; + fire(target: EventTarget, type: string, properties: any): any; + siblingIndex(el: Element): number; }; static FILTER_STARTSWITH: (text: string, input: string) => boolean; static FILTER_CONTAINS: (text: string, input: string) => boolean; @@ -45,11 +45,11 @@ declare namespace Awesomplete { minChars?: number; maxItems?: number; autoFirst?: boolean; - data?: (item: Suggestion, input: string) => string; - filter?: (text: string, input: string) => boolean; - sort?: (left: number | any[], right: number | any[]) => number; - item?: (text: string, input: string) => HTMLElement; - replace?: (text: string) => void; + data?(item: Suggestion, input: string): string; + filter?(text: string, input: string): boolean; + sort?(left: number | any[], right: number | any[]): number; + item?(text: string, input: string): HTMLElement; + replace?(text: string): void; } } diff --git a/types/babel-code-frame/index.d.ts b/types/babel-code-frame/index.d.ts index ebfde63c4c..19d18b6df8 100644 --- a/types/babel-code-frame/index.d.ts +++ b/types/babel-code-frame/index.d.ts @@ -4,7 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface BabelCodeFrameOptions { - /** Syntax highlight the code as JavaScript for terminals. default: false*/ + /** Syntax highlight the code as JavaScript for terminals. default: false */ highlightCode?: boolean; /** The number of lines to show above the error. default: 2 */ linesBelow?: number; diff --git a/types/base-64/index.d.ts b/types/base-64/index.d.ts index ddd10db17b..26cb9c4a41 100644 --- a/types/base-64/index.d.ts +++ b/types/base-64/index.d.ts @@ -22,4 +22,4 @@ export function encode(input: string): string; * with atob() as described in the HTML Standard. * see: https://html.spec.whatwg.org/multipage/webappapis.html#dom-windowbase64-atob */ -export function decode(input: string): string; \ No newline at end of file +export function decode(input: string): string; diff --git a/types/bigi/bigi-tests.ts b/types/bigi/bigi-tests.ts index 70569bb919..ef9d7421d3 100644 --- a/types/bigi/bigi-tests.ts +++ b/types/bigi/bigi-tests.ts @@ -1,9 +1,9 @@ import BigInteger = require('bigi'); -var b1 = BigInteger.fromHex("188DA80EB03090F67CBF20EB43A18800F4FF0AFD82FF1012"); -var b2 = BigInteger.fromHex("07192B95FFC8DA78631011ED6B24CDD573F977A11E794811"); +const b1 = BigInteger.fromHex("188DA80EB03090F67CBF20EB43A18800F4FF0AFD82FF1012"); +const b2 = BigInteger.fromHex("07192B95FFC8DA78631011ED6B24CDD573F977A11E794811"); -var b3 = b1.multiply(b2); +const b3 = b1.multiply(b2); console.log(b3.toHex()); -// => ae499bfe762edfb416d0ce71447af67ff33d1760cbebd70874be1d7a5564b0439a59808cb1856a91974f7023f72132 \ No newline at end of file +// => ae499bfe762edfb416d0ce71447af67ff33d1760cbebd70874be1d7a5564b0439a59808cb1856a91974f7023f72132 diff --git a/types/bignumber.js/bignumber.js-tests.ts b/types/bignumber.js/bignumber.js-tests.ts index 9dc96dd7ea..8ea0775dba 100644 --- a/types/bignumber.js/bignumber.js-tests.ts +++ b/types/bignumber.js/bignumber.js-tests.ts @@ -1,5 +1,5 @@ -var x: BigNumber.BigNumber = new BigNumber(9); -var y = new BigNumber(x); +let x: BigNumber.BigNumber = new BigNumber(9); +let y = new BigNumber(x); BigNumber(435.345); @@ -27,7 +27,7 @@ new BigNumber(1.23456789); new BigNumber(1.23456789, 10); BigNumber.config({ DECIMAL_PLACES: 5 }); -var BN = BigNumber.another({ DECIMAL_PLACES: 9 }); +let BN = BigNumber.another({ DECIMAL_PLACES: 9 }); x = new BigNumber(1); y = new BN(1); @@ -112,14 +112,14 @@ BigNumber.config({ BigNumber.config(40, 7, [-10, 20], 500, 1, 1, 3, 80); -var obj = BigNumber.config(); +const obj = BigNumber.config(); obj.ERRORS; obj.RANGE; x = new BigNumber('3257869345.0378653'); BigNumber.max(4e9, x, '123456789.9'); -var arr = [12, '13', new BigNumber(14)]; +let arr = [12, '13', new BigNumber(14)]; BigNumber.max(arr); x = new BigNumber('3257869345.0378653'); @@ -137,7 +137,7 @@ BigNumber.config({ ROUNDING_MODE: 2 }); x = new BigNumber(-0.8); y = x.absoluteValue(); -var z = y.abs(); +let z = y.abs(); x = new BigNumber(1.3); x.ceil(); @@ -300,7 +300,7 @@ y.toFixed(2); y.toFixed(2, 1); y.toFixed(5); -var format = { +const format = { decimalSeparator: '.', groupSeparator: ',', groupSize: 3, @@ -332,7 +332,7 @@ x.toFormat(6); x = new BigNumber(1.75); x.toFraction(); -var pi = new BigNumber('3.14159265358'); +const pi = new BigNumber('3.14159265358'); pi.toFraction(); pi.toFraction(100000); pi.toFraction(10000); @@ -344,7 +344,7 @@ x = new BigNumber('177.7e+457'); y = new BigNumber(235.4325); z = new BigNumber('0.0098074'); -var str = JSON.stringify([x, y, z]); +const str = JSON.stringify([x, y, z]); JSON.parse(str, (key, val) => key === '' ? val : new BigNumber(val)); diff --git a/types/bignumber.js/index.d.ts b/types/bignumber.js/index.d.ts index 10423b1ed3..d627ad136c 100644 --- a/types/bignumber.js/index.d.ts +++ b/types/bignumber.js/index.d.ts @@ -673,4 +673,4 @@ declare namespace BigNumber { */ isBigNumber: true; } -} \ No newline at end of file +} diff --git a/types/bitcoinjs-lib/bitcoinjs-lib-tests.ts b/types/bitcoinjs-lib/bitcoinjs-lib-tests.ts index bdaee3ee83..7267fe5d26 100644 --- a/types/bitcoinjs-lib/bitcoinjs-lib-tests.ts +++ b/types/bitcoinjs-lib/bitcoinjs-lib-tests.ts @@ -3,9 +3,9 @@ import bigi = require('bigi'); import bitcoin = require('bitcoinjs-lib'); -declare var it: any; -declare var describe: any; -declare var assert: any; +declare const it: any; +declare const describe: any; +declare const assert: any; describe('bitcoinjs-lib (basic)', () => { it('can generate a random bitcoin address', () => { @@ -13,18 +13,18 @@ describe('bitcoinjs-lib (basic)', () => { function rng() { return new Buffer('zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz'); } // generate random keyPair - var keyPair = bitcoin.ECPair.makeRandom({ rng }); - var address = keyPair.getAddress(); + const keyPair = bitcoin.ECPair.makeRandom({ rng }); + const address = keyPair.getAddress(); assert.strictEqual(address, '1F5VhMHukdnUES9kfXqzPzMeF1GPHKiF64'); }); it('can generate an address from a SHA256 hash', () => { - var hash = bitcoin.crypto.sha256('correct horse battery staple'); - var d = bigi.fromBuffer(hash); + const hash = bitcoin.crypto.sha256('correct horse battery staple'); + const d = bigi.fromBuffer(hash); - var keyPair = new bitcoin.ECPair(d); - var address = keyPair.getAddress(); + const keyPair = new bitcoin.ECPair(d); + const address = keyPair.getAddress(); assert.strictEqual(address, '1C7zdTfnkzmr13HfA2vNm5SJYRK6nEKyq8'); }); @@ -33,26 +33,26 @@ describe('bitcoinjs-lib (basic)', () => { // for testing only function rng() { return new Buffer('zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz'); } - var litecoin = bitcoin.networks.litecoin; + const litecoin = bitcoin.networks.litecoin; - var keyPair = bitcoin.ECPair.makeRandom({ network: litecoin, rng }); - var wif = keyPair.toWIF(); - var address = keyPair.getAddress(); + const keyPair = bitcoin.ECPair.makeRandom({ network: litecoin, rng }); + const wif = keyPair.toWIF(); + const address = keyPair.getAddress(); assert.strictEqual(address, 'LZJSxZbjqJ2XVEquqfqHg1RQTDdfST5PTn'); assert.strictEqual(wif, 'T7A4PUSgTDHecBxW1ZiYFrDNRih2o7M8Gf9xpoCgudPF9gDiNvuS'); }); it('can import an address via WIF', () => { - var keyPair = bitcoin.ECPair.fromWIF('Kxr9tQED9H44gCmp6HAdmemAzU3n84H3dGkuWTKvE23JgHMW8gct'); - var address = keyPair.getAddress(); + const keyPair = bitcoin.ECPair.fromWIF('Kxr9tQED9H44gCmp6HAdmemAzU3n84H3dGkuWTKvE23JgHMW8gct'); + const address = keyPair.getAddress(); assert.strictEqual(address, '19AAjaTUbRjQCMuVczepkoPswiZRhjtg31'); }); it('can create a Transaction', () => { - var keyPair = bitcoin.ECPair.fromWIF('L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy'); - var tx = new bitcoin.TransactionBuilder(); + const keyPair = bitcoin.ECPair.fromWIF('L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy'); + const tx = new bitcoin.TransactionBuilder(); tx.addInput('aa94ab02c182214f090e99a0d57021caffd0f195a81c24602b1028b130b63e31', 0); tx.addOutput('1Gokm82v6DmtwKEB8AiVhm82hyFSsEvBDK', 15000); diff --git a/types/bittorrent-protocol/bittorrent-protocol-tests.ts b/types/bittorrent-protocol/bittorrent-protocol-tests.ts index f5f6b4649f..c32b2af368 100644 --- a/types/bittorrent-protocol/bittorrent-protocol-tests.ts +++ b/types/bittorrent-protocol/bittorrent-protocol-tests.ts @@ -7,7 +7,7 @@ class TestExtension implements Protocol.Extension { } net.createServer(socket => { - var wire = new Protocol(); + const wire = new Protocol(); wire.use(TestExtension); diff --git a/types/bittorrent-protocol/index.d.ts b/types/bittorrent-protocol/index.d.ts index 6d838a90f5..b5ef1a4a44 100644 --- a/types/bittorrent-protocol/index.d.ts +++ b/types/bittorrent-protocol/index.d.ts @@ -10,30 +10,30 @@ import * as stream from 'stream'; declare const BittorrentProtocol: BittorrentProtocol.BittorrentProtocol; declare namespace BittorrentProtocol { - export interface BittorrentProtocol { + interface BittorrentProtocol { new (): Wire; (): Wire; } - export interface ExtensionConstructor { + interface ExtensionConstructor { new (wire: Wire): Extension; } - export interface Extension { - onHandshake?: (infoHash: string, peerId: string, extensions: { [name: string]: boolean }) => void; - onExtendedHandshake?: (handshake: { [key: string]: any }) => void; - onMessage?: (buf: Buffer) => void; + interface Extension { + onHandshake?(infoHash: string, peerId: string, extensions: { [name: string]: boolean }): void; + onExtendedHandshake?(handshake: { [key: string]: any }): void; + onMessage?(buf: Buffer): void; name: string; } - export interface Request { + interface Request { piece: number; offset: number; length: number; - callback: () => void; + callback(): void; } - export interface Wire extends stream.Duplex { + interface Wire extends stream.Duplex { readonly peerId: string; // remote peer id (hex string) readonly peerIdBuffer: Buffer; // remote peer id (Buffer) readonly type: 'webrtc' | 'tcpIncoming' | 'tcpOutgoing' | 'webSeed'; // connection type diff --git a/types/blacklist/blacklist-tests.ts b/types/blacklist/blacklist-tests.ts index 0f465dd62a..5c5803c45c 100644 --- a/types/blacklist/blacklist-tests.ts +++ b/types/blacklist/blacklist-tests.ts @@ -1,4 +1,4 @@ -var someInput = { a: 1, b: 2, c: 3 }; +const someInput = { a: 1, b: 2, c: 3 }; import blacklist = require('blacklist'); @@ -10,4 +10,4 @@ blacklist(someInput, { b: false, // b will be in the result c: 1 > 2 // false, therefore c will be in the result }); -// => { b: 2, c: 3 } \ No newline at end of file +// => { b: 2, c: 3 } diff --git a/types/body-parser/index.d.ts b/types/body-parser/index.d.ts index 2b17b20ed4..54a9b463ed 100644 --- a/types/body-parser/index.d.ts +++ b/types/body-parser/index.d.ts @@ -17,11 +17,11 @@ declare namespace bodyParser { inflate?: boolean; limit?: number | string; type?: string | string[] | ((req: Request) => any); - verify?: (req: Request, res: Response, buf: Buffer, encoding: string) => void; + verify?(req: Request, res: Response, buf: Buffer, encoding: string): void; } interface OptionsJson extends Options { - reviever?: (key: string, value: any) => any; + reviever?(key: string, value: any): any; strict?: boolean; } diff --git a/types/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-tests.ts b/types/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-tests.ts index 70c8f8a586..9f2b780f44 100644 --- a/types/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-tests.ts +++ b/types/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-tests.ts @@ -157,7 +157,7 @@ function inputParser(inputDate: string | Date | moment.Moment) { return moment(); } } -}; +} function test_parseInputDate() { let undef: undefined; diff --git a/types/bootstrap.v3.datetimepicker/index.d.ts b/types/bootstrap.v3.datetimepicker/index.d.ts index 653135057d..7b54c57dae 100644 --- a/types/bootstrap.v3.datetimepicker/index.d.ts +++ b/types/bootstrap.v3.datetimepicker/index.d.ts @@ -19,11 +19,11 @@ export as namespace BootstrapV3DatetimePicker; type InputParser = (input: string | Date | moment.Moment) => moment.Moment; export interface Datetimepicker { - /**Clears the datepicker by setting the value to null */ + /** Clears the datepicker by setting the value to null */ clear(): void; - /**Returns the component's model current date, a moment object or null if not set. */ + /** Returns the component's model current date, a moment object or null if not set. */ date(): moment.Moment; - /**Takes string, Date, moment, null parameter and sets the components model current moment to it. + /** Takes string, Date, moment, null parameter and sets the components model current moment to it. * Passing a null value unsets the components model current moment. * Parsing of the newDate parameter is made using moment library with the options.format and options.useStrict components configuration. * Throws: @@ -33,32 +33,34 @@ export interface Datetimepicker { * - dp.change - In case newDate is different from current moment */ date(date: moment.Moment | Date | string | null): void; - /**Destroys the widget and removes all attached event listeners */ + /** Destroys the widget and removes all attached event listeners */ destroy(): void; - /**Disables the input element, the component is attached to, by adding a disabled="true" attribute to it. If the widget was visible before that call it is hidden. + /** Disables the input element, the component is attached to, by adding a disabled="true" attribute to it. If the widget was visible before that call it is hidden. * Emits: * - dp.hide - if the widget was visible before that call */ disable(): void; - /**Enables the input element, the component is attached to, by removing disabled attribute from it. */ + /** Enables the input element, the component is attached to, by removing disabled attribute from it. */ enable(): void; - /**Hides the widget + /** Hides the widget * Emits: * - dp.hide - if the widget was visible before that call */ hide(): void; - /**Returns the components current options object. - * Note that the changing the values of the returned object does not change the components actual configuration. */ + /** + * Returns the components current options object. + * Note that the changing the values of the returned object does not change the components actual configuration. + */ options(): DatetimepickerOptions; - /**Takes an object variable with option key:value properties and configures the component. Use this to update multiple options on the component. */ + /** Takes an object variable with option key:value properties and configures the component. Use this to update multiple options on the component. */ options(options: DatetimepickerOptions): void; - /**Shows the widget + /** Shows the widget * Emits: * - dp.show - if the widget was hidden before that call * - dp.change - if the widget is opened for the first time and the useCurrent is set to true or to a granularity value and the input element the component is attached to has an empty value */ show(): void; - /**Shows or hides the widget + /** Shows or hides the widget * Emits: * - dp.hide - if the widget is hidden after the toggle call * - dp.show - if the widget is show after the toggle call @@ -70,97 +72,108 @@ export interface Datetimepicker { //// Below are the getters/setters for the properties of the 'options(): DatetimepickerOptions' //// //////////////////////////////////////////////////////////////////////////////////////////////////// - /**Returns the options.allowInputToggle option. */ + /** Returns the options.allowInputToggle option. */ allowInputToggle(): boolean; - /**If true, the picker will show on textbox focus and icon click when used in a button group */ + /** If true, the picker will show on textbox focus and icon click when used in a button group */ allowInputToggle(value: boolean): void; - /**Returns the current options.calendarWeeks option configuration */ + /** Returns the current options.calendarWeeks option configuration */ calendarWeeks(): boolean; - /**Set if the week numbers will appear to the left on the days view */ + /** Set if the week numbers will appear to the left on the days view */ calendarWeeks(value: boolean): void; - /**Returns the options.collapse option configuration */ + /** Returns the options.collapse option configuration */ collapse(): boolean; - /**If set to false the picker will display similar to sideBySide except vertical. */ + /** If set to false the picker will display similar to sideBySide except vertical. */ collapse(value: boolean): void; - /**Returns the options.daysOfWeekDisabled configuration + /** + * Returns the options.daysOfWeekDisabled configuration * IMPORTANT! Throws exception if not set explicitly https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1459 - */ + */ daysOfWeekDisabled(): number[]; - /**Takes an [ Number:0 to 6 ] and disallow the user to select weekdays that exist in this array. + /** Takes an [ Number:0 to 6 ] and disallow the user to select weekdays that exist in this array. * This has lower priority over the options.minDate, options.maxDate, options.disabledDates and options.enabledDates configuration settings. * Emits: * - dp.change - if the currently selected moment falls in the values passed on the daysOfWeek parameter. * - dp.error - if the currently selected moment falls in the values passed on the daysOfWeek parameter. */ daysOfWeekDisabled(days: number[]): void; - /**Returns the options.dayViewHeaderFormat option. */ + /** Returns the options.dayViewHeaderFormat option. */ dayViewHeaderFormat(): string; - /**Used to customize the header of the day view. */ + /** Used to customize the header of the day view. */ dayViewHeaderFormat(value: string): void; - /**Returns a moment with the options.defaultDate option configuration or false if not set */ + /** Returns a moment with the options.defaultDate option configuration or false if not set */ defaultDate(): moment.Moment | boolean; - /**Will set the picker's inital date. + /** + * Will set the picker's inital date. * If a boolean:false value is passed the options.defaultDate parameter is cleared. * Throws: * - TypeError - if the provided date doesn't pass validation, including disabledDates, enabledDates, minDate, maxDate, and daysOfWeekDisabled * - TypeError - if the provided date cannot be parsed by momentjs */ defaultDate(date: string | Date | moment.Moment | boolean): void; - /**Returns the options.disabledDates option. + /** + * Returns the options.disabledDates option. * NOTES: probably should be: disabledDates(): boolean | Array; see: DatetimepickerOptions - */ + */ disabledDates(): boolean | any; - /**Takes an array of values and disallows the user to select those days. + /** + * Takes an array of values and disallows the user to select those days. * Setting this takes precedence over options.minDate, options.maxDate configuration. * Also calling this function removes the configuration of options.enabledDates if such exist. * Note: These values are matched with Day granularity. */ disabledDates(dates: boolean | Array): void; - /**Returns the options.disabledHours option. + /** + * Returns the options.disabledHours option. * NOTES: probably should be: disabledHours(): boolean | number[]; see: DatetimepickerOptions - */ + */ disabledHours(): boolean | any; - /**Must be in 24 hour format. Will disallow hour selections (much like disabledTimeIntervals) but will affect all days. - * Like en/disabledDates, the en/disabledHours options are mutually exclusive and will reset one of the options back to false. */ + /** + * Must be in 24 hour format. Will disallow hour selections (much like disabledTimeIntervals) but will affect all days. + * Like en/disabledDates, the en/disabledHours options are mutually exclusive and will reset one of the options back to false. + */ disabledHours(value: boolean | number[]): void; - /**Returns the options.disabledTimeIntervals option, or... not exactly + /** Returns the options.disabledTimeIntervals option, or... not exactly * IMPORTANT! Creates an object from the options.disabledTimeIntervals with the keys being numbers, the values being the moment arrays. * eg { "0": [, ], "1": [...] } * https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1498 */ disabledTimeIntervals(): boolean | moment.Moment[][]; - /**Disables time selection between the given moments + /** Disables time selection between the given moments * eg: [[moment({ h: 0 }), moment({ h: 8 })], [moment({ h: 18 }), moment({ h: 24 })]] */ disabledTimeIntervals(value: boolean | moment.Moment[][]): void; - /**Returns the options.enabledDates option + /** + * Returns the options.enabledDates option * NOTES: probably should be: enabledDates(): boolean | Array; see: DatetimepickerOptions - */ + */ enabledDates(): boolean | any; - /**Takes an array of values and allows the user to select only from those days. + /** Takes an array of values and allows the user to select only from those days. * Setting this takes precedence over options.minDate, options.maxDate configuration. * Also calling this function removes the configuration of options.disabledDates if such exist. * Note: These values are matched with Day granularity. */ enabledDates(dates: boolean | Array): void; - /**Returns the options.enabledHours option. + /** + * Returns the options.enabledHours option. * NOTES: probably should be: enabledHours(): boolean | number[]; see: DatetimepickerOptions - */ + */ enabledHours(): boolean | any; - /**Must be in 24 hour format. Will allow hour selections (much like enabledTimeIntervals) but will affect all days. - * Like en/disabledDates, the en/disabledHours options are mutually exclusive and will reset one of the options back to false. */ + /** + * Must be in 24 hour format. Will allow hour selections (much like enabledTimeIntervals) but will affect all days. + * Like en/disabledDates, the en/disabledHours options are mutually exclusive and will reset one of the options back to false. + */ enabledHours(value: boolean | number[]): void; - /**Returns a boolean or array with the options.extraFormats option configuration */ + /** Returns a boolean or array with the options.extraFormats option configuration */ extraFormats(): boolean | Array; - /**Takes an array of valid input moment format options, or boolean:false */ + /** Takes an array of valid input moment format options, or boolean:false */ extraFormats(formats: boolean | Array): void; - /**Returns the options.focusOnShow option. */ + /** Returns the options.focusOnShow option. */ focusOnShow(): boolean; - /**If false, the textbox will not be given focus when the picker is shown */ + /** If false, the textbox will not be given focus when the picker is shown */ focusOnShow(value: boolean): void; - /**Returns the component's options.format string */ + /** Returns the component's options.format string */ format(): boolean | string | moment.MomentBuiltinFormat; - /**Takes a moment.js format string and sets the components options.format. + /** Takes a moment.js format string and sets the components options.format. * This is used for displaying and also for parsing input strings either from the input element the component is attached to or the date() function. * The parameter can also be a boolean:false in which case the format is set to the locale's L LT. * Note: this is also used to determine if the TimePicker sub component will display the hours in 12 or 24 format. (if "a" or "h" exists in the passed string then a 12 hour mode is set) @@ -168,40 +181,41 @@ export interface Datetimepicker { * - TypeError - if format is boolean:true */ format(format: boolean | string | moment.MomentBuiltinFormat): void; - /**Returns options.icons */ + /** Returns options.icons */ icons(): Icons; - /**Takes an Object of strings. + /** Takes an Object of strings. * Throws: * - TypeError - if icons parameter is not an Object */ icons(icons: Icons): void; - /**Returns the options.ignoreReadonly option. */ + /** Returns the options.ignoreReadonly option. */ ignoreReadonly(): boolean; - /**Set this to true to allow the picker to be used even if the input field is readonly. This will not bypass the disabled property */ + /** Set this to true to allow the picker to be used even if the input field is readonly. This will not bypass the disabled property */ ignoreReadonly(value: boolean): void; - /**Returns the options.inline option. */ + /** Returns the options.inline option. */ inline(): boolean; - /**Used to customize the header of the day view. */ + /** Used to customize the header of the day view. */ inline(value: boolean): void; - /**Returns the options.keepInvalid option. */ + /** Returns the options.keepInvalid option. */ keepInvalid(): boolean; - /**If true, invalid dates will not be reverted to a previous selection or changed. */ + /** If true, invalid dates will not be reverted to a previous selection or changed. */ keepInvalid(value: boolean): void; - /**Returns a string variable with the currently set options.keyBinds option. */ + /** Returns a string variable with the currently set options.keyBinds option. */ keyBinds(): any; - /**Allows for several keyBinding functions to be specified for ease of access or accessibility. For defaults see {@link http://eonasdan.github.io/bootstrap-datetimepicker/Options/#keybinds}. - */ + /** + * Allows for several keyBinding functions to be specified for ease of access or accessibility. For defaults see {@link http://eonasdan.github.io/bootstrap-datetimepicker/Options/#keybinds}. + */ keyBinds(value: any): void; - /**Returns the currently set locale of the options.locale */ + /** Returns the currently set locale of the options.locale */ locale(): string; - /**Takes a string of any valid moment locale e.g. de for German. + /** Takes a string of any valid moment locale e.g. de for German. * Throws: * - TypeError - if the locale is not loaded via a separate script or moment-with-locale */ locale(newLocale: string): void; - /**Returns the currently set moment of the options.maxDate or false if not set */ + /** Returns the currently set moment of the options.maxDate or false if not set */ maxDate(): moment.Moment | boolean; - /**Takes a parameter and disallows the user to select a moment that is after that moment. + /** Takes a parameter and disallows the user to select a moment that is after that moment. * If a boolean:false value is passed options.maxDate is cleared and there is no restriction to the maximum moment the user can select. * Note: If the parameter is before the currently selected moment the currently selected moment changes to maxDate * Throws: @@ -213,9 +227,9 @@ export interface Datetimepicker { * - dp.error - if the new maxDate is after currently selected moment */ maxDate(date: moment.Moment | Date | string | boolean): void; - /**Returns the currently set moment of the options.minDate or false if not set */ + /** Returns the currently set moment of the options.minDate or false if not set */ minDate(): moment.Moment | boolean; - /**Takes a parameter and disallows the user to select a moment that is before that moment. + /** Takes a parameter and disallows the user to select a moment that is before that moment. * If a boolean:false value is passed the options.minDate parameter is cleared and there is no restriction to the miminum moment the user can select. * Note: If the parameter is after the currently selected moment the currently selected moment changes to minDate parameter * Throws: @@ -227,31 +241,31 @@ export interface Datetimepicker { * - dp.error - if the new minDate is after currently selected moment */ minDate(date: moment.Moment | Date | string | boolean): void; - /**Returns the options.parseInputDate option */ + /** Returns the options.parseInputDate option */ parseInputDate(): InputParser | undefined; - /**Allows custom input formatting For example: the user can enter "yesterday"" or "30 days ago". + /** Allows custom input formatting For example: the user can enter "yesterday"" or "30 days ago". * {@link http://eonasdan.github.io/bootstrap-datetimepicker/Functions/#parseinputdate} */ parseInputDate(value: InputParser): void; - /**Returns the options.showClear option. */ + /** Returns the options.showClear option. */ showClear(): boolean; - /**Set if the clear date button will appear on the widget */ + /** Set if the clear date button will appear on the widget */ showClear(value: boolean): void; - /**Returns the options.showClose option. */ + /** Returns the options.showClose option. */ showClose(): boolean; - /**If true, an icon will be displayed on the toolbar that will hide the picker */ + /** If true, an icon will be displayed on the toolbar that will hide the picker */ showClose(value: boolean): void; - /**Returns the options.showTodayButton option. */ + /** Returns the options.showTodayButton option. */ showTodayButton(): boolean; - /**Set if the Today button will appear on the widget */ + /** Set if the Today button will appear on the widget */ showTodayButton(value: boolean): void; - /**Returns a boolean of the options.sideBySide. */ + /** Returns a boolean of the options.sideBySide. */ sideBySide(): boolean; - /**If sideBySide is true and the time picker is used, both components will display side by side instead of collapsing. */ + /** If sideBySide is true and the time picker is used, both components will display side by side instead of collapsing. */ sideBySide(value: boolean): void; - /**Returns a number with the options.stepping option configuration */ + /** Returns a number with the options.stepping option configuration */ stepping(): number; - /**This will be the amount the up/down arrows move the minute value with a time picker. */ + /** This will be the amount the up/down arrows move the minute value with a time picker. */ stepping(step: number): void; /** Returns a string of options.timeZone */ timeZone(): string | null; @@ -260,24 +274,24 @@ export interface Datetimepicker { * - TypeError - if tooltips parameter is not a string or null */ timeZone(timeZone: string | null): void; - /**Returns the options.toolbarplacement option. */ + /** Returns the options.toolbarplacement option. */ toolbarPlacement(): string; - /**Changes the placement of the toolbar where the today, clear, component switch icon are located. + /** Changes the placement of the toolbar where the today, clear, component switch icon are located. * See valid values at DatetimepickerOptions.toolbarplacement * Throws: * - TypeError - if the parameter is not a valid value */ toolbarPlacement(value: string): void; - /**Returns the options.tooltips option */ + /** Returns the options.tooltips option */ tooltips(): Tooltips; - /**Sets the tooltips for icons. + /** Sets the tooltips for icons. * Throws: * - TypeError - if tooltips parameter is not an Object */ tooltips(value: Tooltips): void; - /**Returns the options.useCurrent option configuration */ + /** Returns the options.useCurrent option configuration */ useCurrent(): boolean | string; - /**Takes a boolean or string. + /** Takes a boolean or string. * If a boolean true is passed and the components model moment is not set (either through setDate or through a valid value on the input element the component is attached to) * then the first time the user opens the datetimepicker widget the value is initialized to the current moment of the action. * If a false boolean is passed then no initialization happens on the input element. @@ -287,28 +301,28 @@ export interface Datetimepicker { * Note: If the options.defaultDate is set or the input element the component is attached to has already a value that takes precedence and the functionality of useCurrent is not triggered! */ useCurrent(value: boolean | string): void; - /**Returns the options.useStrict */ + /** Returns the options.useStrict */ useStrict(): boolean; - /**If useStrict is true, momentjs parsing rules will be stricter when determining if a date is valid or not. */ + /** If useStrict is true, momentjs parsing rules will be stricter when determining if a date is valid or not. */ useStrict(value: boolean): void; - /**Returns the options.viewDate option. */ + /** Returns the options.viewDate option. */ viewDate(): boolean | moment.Moment; - /**This will change the viewDate without changing or setting the selected date. */ + /** This will change the viewDate without changing or setting the selected date. */ viewDate(value: string | Date | moment.Moment | boolean): void; - /**Returns the options.viewMode. */ + /** Returns the options.viewMode. */ viewMode(): string; - /**Takes a string. See valid values at DatetimepickerOptions.viewMode + /** Takes a string. See valid values at DatetimepickerOptions.viewMode * Throws: * - TypeError - if the parameter is not a string or not a valid value */ viewMode(value: string): void; - /**Returns a $(element) variable with the currently set options.widgetParent option. */ + /** Returns a $(element) variable with the currently set options.widgetParent option. */ widgetParent(): string | JQuery | null; - /**Takes a string or $(element) value. */ + /** Takes a string or $(element) value. */ widgetParent(widgetParent: string | JQuery | null): void; - /**Returns the options.widgetPositioning object */ + /** Returns the options.widgetPositioning object */ widgetPositioning(): WidgetPositioningOptions; - /**WidgetPositioning defines where the dropdown with the widget will appear relative to the input element the component is attached to. + /** WidgetPositioning defines where the dropdown with the widget will appear relative to the input element the component is attached to. * "auto" is the default value for both horizontal and vertical keys and it tries to automatically place the dropdown in a position that is visible to the user. * Usually you should not override those options unless you have a special need in your layout. */ @@ -316,91 +330,91 @@ export interface Datetimepicker { } export interface DatetimepickerOptions { - /**If true, the picker will show on textbox focus and icon click when used in a button group + /** If true, the picker will show on textbox focus and icon click when used in a button group * @default: false */ allowInputToggle?: boolean; - /**Shows the week of the year to the left of first day of the week. + /** Shows the week of the year to the left of first day of the week. * @default: false */ calendarWeeks?: boolean; - /**Using a Bootstraps collapse to switch between date/time pickers. + /** Using a Bootstraps collapse to switch between date/time pickers. * @default: true */ collapse?: boolean; - /**Disables the section of days of the week, e.g. weekends. + /** Disables the section of days of the week, e.g. weekends. * Accepts: array of numbers from 0-6 * @default: false */ daysOfWeekDisabled?: number[] | boolean; - /**Changes the heading of the datepicker when in "days" view. + /** Changes the heading of the datepicker when in "days" view. * @default: "MMMM YYYY" */ dayViewHeaderFormat?: string; - /**Will cause the date picker to stay open after a blur event. + /** Will cause the date picker to stay open after a blur event. * @default: false */ debug?: boolean; - /**Sets the picker default date/time. Overrides useCurrent + /** Sets the picker default date/time. Overrides useCurrent * @default: false */ defaultDate?: boolean | moment.Moment | Date | string; - /**Disables selection of dates in the array, e.g. holidays + /** Disables selection of dates in the array, e.g. holidays * @default: false * IMPORTANT! The getter returns an Object NOT an Array, with keys being the dates, values being true. * eg disabledDates = ["2010-10-10"]; -> disabledDated will be { "2010-01-01": true } * https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1499 */ disabledDates?: boolean | Array | any; - /**Will allow or disallow hour selections (much like disabledTimeIntervals) but will affect all days + /** Will allow or disallow hour selections (much like disabledTimeIntervals) but will affect all days * @default: false * IMPORTANT! The getter returns an Object NOT an Array, with keys being the hours, values being true. * eg disabledHours = [0, 1]; -> disabledHours will be { "0": true, "1": true } * https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1499 */ disabledHours?: boolean | number[] | any; - /**Disables time selection between the given moments + /** Disables time selection between the given moments * eg: [[moment({ h: 0 }), moment({ h: 8 })], [moment({ h: 18 }), moment({ h: 24 })]] * @default: false */ disabledTimeIntervals?: boolean | moment.Moment[][]; - /**Disables selection of dates NOT in the array, e.g. holidays + /** Disables selection of dates NOT in the array, e.g. holidays * @default: false * IMPORTANT! The getter returns an Object NOT an Array, with keys being the dates, values being true. * eg enabledDates = ["2010-10-10"]; -> enabledDated will be { "2010-01-01": true } * https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1499 */ enabledDates?: boolean | Array | any; - /**Will allow or disallow hour selections (much like disabledTimeIntervals) but will affect all days + /** Will allow or disallow hour selections (much like disabledTimeIntervals) but will affect all days * @default: false * IMPORTANT! The getter returns an Object NOT an Array, with keys being the hours, values being true. * eg enabledHours = [0, 1]; -> enabledHours will be { "0": true, "1": true } * https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1499 */ enabledHours?: boolean | number[]; - /**Allows for several input formats to be valid. See: https://github.com/Eonasdan/bootstrap-datetimepicker/pull/666 + /** Allows for several input formats to be valid. See: https://github.com/Eonasdan/bootstrap-datetimepicker/pull/666 * @default: false */ extraFormats?: boolean | Array; - /**If false, the textbox will not be given focus when the picker is shown + /** If false, the textbox will not be given focus when the picker is shown * @default: true */ focusOnShow?: boolean; - /**See momentjs' docs for valid formats. Format also dictates what components are shown, e.g. MM/dd/YYYY will not display the time picker. + /** See momentjs' docs for valid formats. Format also dictates what components are shown, e.g. MM/dd/YYYY will not display the time picker. * @default: false */ format?: boolean | string | moment.MomentBuiltinFormat; - /**Change the default icons for the pickers functions. */ + /** Change the default icons for the pickers functions. */ icons?: Icons; - /**Allow date picker show event to fire even when the associated input element has the readonly="readonly"property. + /** Allow date picker show event to fire even when the associated input element has the readonly="readonly"property. * @default: false */ ignoreReadonly?: boolean; - /**Will display the picker inline without the need of a input field. This will also hide borders and shadows. + /** Will display the picker inline without the need of a input field. This will also hide borders and shadows. * @default: false */ inline?: boolean; - /**Allows for custom events to fire on keyboard press. + /** Allows for custom events to fire on keyboard press. * eg: keybinds: { * up: (widget) => console.log(widget), * "control up": (widget) => console.log(widget) @@ -408,52 +422,52 @@ export interface DatetimepickerOptions { * The widget parameter is false, if the datepicker is closed. */ keyBinds?: { [key: string]: (widget: boolean | JQuery) => void }; - /**Will cause the date picker to not revert or overwrite invalid dates. + /** Will cause the date picker to not revert or overwrite invalid dates. * @default: false */ keepInvalid?: boolean; - /**Will cause the date picker to stay open after selecting a date if no time components are being used. + /** Will cause the date picker to stay open after selecting a date if no time components are being used. * @default: false */ keepOpen?: boolean; - /**See momentjs for valid locales. You must include moment-with-locales.js or a local js file. + /** See momentjs for valid locales. You must include moment-with-locales.js or a local js file. * @default: moment.locale() */ locale?: string; - /**Prevents date/time selections after this date. + /** Prevents date/time selections after this date. * maxDate will override defaultDate and useCurrent if either of these settings are the same day since both options are invalid according to the rules you've selected. * @default: false */ maxDate?: boolean | moment.Moment | Date | string; - /**Prevents date/time selections before this date. + /** Prevents date/time selections before this date. * minDate will override defaultDate and useCurrent if either of these settings are the same day since both options are invalid according to the rules you've selected. * @default: false */ minDate?: boolean | moment.Moment | Date | string; - /**Allows custom input formatting For example: the user can enter "yesterday"" or "30 days ago". + /** Allows custom input formatting For example: the user can enter "yesterday"" or "30 days ago". * {@link http://eonasdan.github.io/bootstrap-datetimepicker/Functions/#parseinputdate} */ parseInputDate?: InputParser; - /**Show the "Clear" button in the icon toolbar. + /** Show the "Clear" button in the icon toolbar. * Clicking the "Clear" button will set the calendar to null. * @default: false */ showClear?: boolean; - /**Show the "Close" button in the icon toolbar. + /** Show the "Close" button in the icon toolbar. * Clicking the "Close" button will call hide() * @default: false */ showClose?: boolean; - /**Show the "Today" button in the icon toolbar. + /** Show the "Today" button in the icon toolbar. * Clicking the "Today" button will set the calendar view and set the date to now. * @default: false */ showTodayButton?: boolean; - /**Shows the picker side by side when using the time and date together. + /** Shows the picker side by side when using the time and date together. * @default: false */ sideBySide?: boolean; - /**Number of minutes the up/down arrow's will move the minutes value in the time picker + /** Number of minutes the up/down arrow's will move the minutes value in the time picker * @default: 1 */ stepping?: number; @@ -462,30 +476,30 @@ export interface DatetimepickerOptions { * @default: "" */ timeZone?: string | null; - /**Changes the placement of the icon toolbar. + /** Changes the placement of the icon toolbar. * @default: "default" */ toolbarPlacement?: "default" | "top" | "bottom"; - /**This will change the tooltips over each icon to a custom string */ + /** This will change the tooltips over each icon to a custom string */ tooltips?: Tooltips; - /**On show, will set the picker to the current date/time + /** On show, will set the picker to the current date/time * @default: true */ useCurrent?: boolean; - /**Defines if moment should use strict date parsing when considering a date to be valid + /** Defines if moment should use strict date parsing when considering a date to be valid * @default: false */ useStrict?: boolean; - /**This will change the viewDate without changing or setting the selected date. + /** This will change the viewDate without changing or setting the selected date. * @default: false */ viewDate?: boolean | moment.Moment | Date | string; - /**The default view to display when the picker is shown. + /** The default view to display when the picker is shown. * Note: To limit the picker to selecting, for instance the year and month, use format: MM/YYYY * @default: "days" */ viewMode?: "decades" | "years" | "months" | "days"; - /**On picker show, places the widget at the identifier (string) or jQuery object if the element has css position: "relative" + /** On picker show, places the widget at the identifier (string) or jQuery object if the element has css position: "relative" * @default: null */ widgetParent?: string | JQuery | null; @@ -493,23 +507,23 @@ export interface DatetimepickerOptions { } export interface Icons { - /**default: "glyphicon glyphicon-trash" */ + /** default: "glyphicon glyphicon-trash" */ clear?: string; - /**default: "glyphicon glyphicon-remove" */ + /** default: "glyphicon glyphicon-remove" */ close?: string; - /**default: "glyphicon glyphicon-calendar" */ + /** default: "glyphicon glyphicon-calendar" */ date?: string; - /**default: "glyphicon glyphicon-time" */ + /** default: "glyphicon glyphicon-time" */ down?: string; - /**default: "glyphicon glyphicon-chevron-left" */ + /** default: "glyphicon glyphicon-chevron-left" */ next?: string; - /**default: "glyphicon glyphicon-screenshot" */ + /** default: "glyphicon glyphicon-screenshot" */ previous?: string; - /**default: "glyphicon glyphicon-chevron-right" */ + /** default: "glyphicon glyphicon-chevron-right" */ time?: string; - /**default: "glyphicon glyphicon-chevron-down" */ + /** default: "glyphicon glyphicon-chevron-down" */ today?: string; - /**default: "glyphicon glyphicon-chevron-up" */ + /** default: "glyphicon glyphicon-chevron-up" */ up?: string; } @@ -551,14 +565,14 @@ export interface Event extends JQueryEventObject { } export interface ChangeEvent extends Event { - /**Previous date. False if the previous date is null. */ + /** Previous date. False if the previous date is null. */ oldDate: moment.Moment | boolean; } export interface UpdateEvent extends JQueryEventObject { - /**Change type as a momentjs format token. e.g. yyyy on year change */ + /** Change type as a momentjs format token. e.g. yyyy on year change */ change: string; - /**New viewDate. */ + /** New viewDate. */ viewDate: moment.Moment; } diff --git a/types/braintree-web/index.d.ts b/types/braintree-web/index.d.ts index 6d896a5efe..a30a880684 100644 --- a/types/braintree-web/index.d.ts +++ b/types/braintree-web/index.d.ts @@ -7,7 +7,7 @@ * @module braintree-web/american-express * @description This module is for use with Amex Express Checkout. To accept American Express cards, use Hosted Fields. */ -declare namespace BraintreeWeb { +declare namespace braintree { export interface AmericanExpress { /** * @static @@ -24,22 +24,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options Options - * @description You cannot use this constructor directly. Use {@link module:braintree-web/american-express.create|braintree.american-express.create} instead. - * @classdesc This class allows you use a nonce to interact with American Express Checkout. To accept American Express cards, use Hosted Fields. - */ - export class AmericanExpress { - /** - * @class - * @param {object} options Options - * @description You cannot use this constructor directly. Use {@link module:braintree-web/american-express.create|braintree.american-express.create} instead. - * @classdesc This class allows you use a nonce to interact with American Express Checkout. To accept American Express cards, use Hosted Fields. - */ - constructor(options: any); /** * Gets the rewards balance associated with a Braintree nonce. @@ -63,7 +47,7 @@ declare namespace BraintreeWeb { * }); * }); */ - public getRewardsBalance(options: { nonce: string }, callback: callback): void; + getRewardsBalance(options: { nonce: string }, callback: callback): void; /** * Gets the Express Checkout nonce profile given a nonce from American Express. @@ -87,121 +71,123 @@ declare namespace BraintreeWeb { * }); * }); */ - public getExpressCheckoutProfile(options: { nonce: string }, callback: callback): void; + getExpressCheckoutProfile(options: { nonce: string }, callback: callback): void; } } -// more info https://developer.apple.com/reference/applepayjs/1916082-applepay_js_data_types/paymentrequest +declare namespace braintree { + // more info https://developer.apple.com/reference/applepayjs/1916082-applepay_js_data_types/paymentrequest -// billingContact -// Billing contact information for the user. -// countryCode -//Required.The merchant’s two- letter ISO 3166 country code. -// currencyCode -// Required.The three- letter ISO 4217 currency code for the payment. -// lineItems -//A set of line items that explain recurring payments and additional charges. -// merchantCapabilities -// Required.The payment capabilities supported by the merchant.The value must be one or more of supports3DS, supportsEMV, supportsCredit, or supportsDebit. -// requiredBillingContactFields -// The billing information that is required from the user.The value must be one or more of postalAddress, phone, email, or name. -// requiredShippingContactFields -// The shipping information that is required from the user.The value must be one or more of postalAddress, phone, email, or name. -// shippingContact -// Shipping contact information for the user. -// shippingMethods -//A set of available shipping methods.Totals for all shipping methods must be non- negative to pass validation. -// shippingType -// How the items are to be shipped.This property is optional.If specified, it must be one or more of shipping, delivery, storePickup, or servicePickup.The default value is shipping. -// supportedNetworks -// Required.The payment networks supported by the merchant.The value must be one or more of amex, discover, interac, masterCard, privateLabel, or visa. -// total -// Required.The total amount for the payment.The total must be greater than zero and have a label to pass validation. -interface ApplePayPaymentRequest { - total: { - label: string; - amount: string; - }; - countryCode: string; - currencyCode: string; - supportedNetworks: string[]; - merchantCapabilities: string[]; + // billingContact + // Billing contact information for the user. + // countryCode + //Required.The merchant’s two- letter ISO 3166 country code. + // currencyCode + // Required.The three- letter ISO 4217 currency code for the payment. + // lineItems + //A set of line items that explain recurring payments and additional charges. + // merchantCapabilities + // Required.The payment capabilities supported by the merchant.The value must be one or more of supports3DS, supportsEMV, supportsCredit, or supportsDebit. + // requiredBillingContactFields + // The billing information that is required from the user.The value must be one or more of postalAddress, phone, email, or name. + // requiredShippingContactFields + // The shipping information that is required from the user.The value must be one or more of postalAddress, phone, email, or name. + // shippingContact + // Shipping contact information for the user. + // shippingMethods + //A set of available shipping methods.Totals for all shipping methods must be non- negative to pass validation. + // shippingType + // How the items are to be shipped.This property is optional.If specified, it must be one or more of shipping, delivery, storePickup, or servicePickup.The default value is shipping. + // supportedNetworks + // Required.The payment networks supported by the merchant.The value must be one or more of amex, discover, interac, masterCard, privateLabel, or visa. + // total + // Required.The total amount for the payment.The total must be greater than zero and have a label to pass validation. + interface ApplePayPaymentRequest { + total: { + label: string; + amount: string; + }; + countryCode: string; + currencyCode: string; + supportedNetworks: string[]; + merchantCapabilities: string[]; - billingContact?: any; - shippingContact?: any; - shippingMethods?: any; - shippingType?: any; - requiredBillingContactFields?: any; - requiredShippingContactFields?: any; -} + billingContact?: any; + shippingContact?: any; + shippingMethods?: any; + shippingType?: any; + requiredBillingContactFields?: any; + requiredShippingContactFields?: any; + } -declare enum ApplePayStatusCodes { - // The requested action succeeded. - STATUS_SUCCESS = 1, - // The requested action failed. - STATUS_FAILURE, - // The billing address is not valid. - STATUS_INVALID_BILLING_POSTAL_ADDRESS, - // The shipping address is not valid. - STATUS_INVALID_SHIPPING_POSTAL_ADDRESS, - // The shipping contact information is not valid. - STATUS_INVALID_SHIPPING_CONTACT, - // The required PIN information was not provided. Cards on the China Union Pay payment network may require a PIN to authenticate the transaction. - STATUS_PIN_REQUIRED, - // The PIN information is not valid.Cards on the China Union Pay network may require a PIN. - STATUS_PIN_INCORRECT, - // The maximum number of tries for a PIN has been reached and the user has been locked out. Cards on the China Union Pay network may require a PIN. - STATUS_PIN_LOCKOUT, -} + export enum ApplePayStatusCodes { + // The requested action succeeded. + STATUS_SUCCESS = 1, + // The requested action failed. + STATUS_FAILURE, + // The billing address is not valid. + STATUS_INVALID_BILLING_POSTAL_ADDRESS, + // The shipping address is not valid. + STATUS_INVALID_SHIPPING_POSTAL_ADDRESS, + // The shipping contact information is not valid. + STATUS_INVALID_SHIPPING_CONTACT, + // The required PIN information was not provided. Cards on the China Union Pay payment network may require a PIN to authenticate the transaction. + STATUS_PIN_REQUIRED, + // The PIN information is not valid.Cards on the China Union Pay network may require a PIN. + STATUS_PIN_INCORRECT, + // The maximum number of tries for a PIN has been reached and the user has been locked out. Cards on the China Union Pay network may require a PIN. + STATUS_PIN_LOCKOUT, + } -interface ApplePayPayload { - merchantIdentifier: string; - domainName: string; - displayName: string; -} + interface ApplePayPayload { + merchantIdentifier: string; + domainName: string; + displayName: string; + } -declare class ApplePaySession { - constructor(version: number, request: ApplePayPaymentRequest); + export class ApplePaySession { + constructor(version: number, request: ApplePayPaymentRequest); - canMakePayments(): boolean; + canMakePayments(): boolean; - canMakePaymentsWithActiveCard(merchantIdentifier: string): boolean; + canMakePaymentsWithActiveCard(merchantIdentifier: string): boolean; - completeMerchantValidation(merchantSession: any): void; + completeMerchantValidation(merchantSession: any): void; - abort(): void; + abort(): void; - begin(): void; + begin(): void; - completePayment(status: ApplePayStatusCodes): void; + completePayment(status: ApplePayStatusCodes): void; - completePaymentMethodSelection(newTotal: any, newLineItems: any): void; + completePaymentMethodSelection(newTotal: any, newLineItems: any): void; - completeShippingContactSelection(status: ApplePayStatusCodes, newShippingMethods: any, newTotal: any, newLineItems: any): void; + completeShippingContactSelection(status: ApplePayStatusCodes, newShippingMethods: any, newTotal: any, newLineItems: any): void; - completeShippingMethodSelection(status: ApplePayStatusCodes, newTotal: any, newLineItems: any): void; + completeShippingMethodSelection(status: ApplePayStatusCodes, newTotal: any, newLineItems: any): void; - supportsVersion(version: number): boolean; + supportsVersion(version: number): boolean; - oncancel: (event: any) => void; + oncancel: (event: any) => void; - onpaymentauthorized: (event: any) => void; + onpaymentauthorized: (event: any) => void; - onpaymentmethodselected: (event: any) => void; + onpaymentmethodselected: (event: any) => void; - onshippingcontactselected: (event: any) => void; + onshippingcontactselected: (event: any) => void; - onshippingmethodselected: (event: any) => void; + onshippingmethodselected: (event: any) => void; - onvalidatemerchant: (event: any) => void; + onvalidatemerchant: (event: any) => void; + } } /** * @module braintree-web/apple-pay * @description Accept Apple Pay on the Web. *This component is currently in beta and is subject to change.* */ -declare namespace BraintreeWeb { +declare namespace braintree { export interface ApplePay { /** * @static @@ -218,22 +204,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options Options - * @description You cannot use this constructor directly. Use {@link module:braintree-web/apple-pay.create|braintree.apple-pay.create} instead. - * @classdesc This class represents an Apple Pay component. Instances of this class have methods for validating the merchant server and tokenizing payments. - */ - export class ApplePay { - /** - * @class - * @param {object} options Options - * @description You cannot use this constructor directly. Use {@link module:braintree-web/apple-pay.create|braintree.apple-pay.create} instead. - * @classdesc This class represents an Apple Pay component. Instances of this class have methods for validating the merchant server and tokenizing payments. - */ - constructor(options: any); /** * Merges a payment request with Braintree defaults @@ -260,7 +230,7 @@ declare namespace BraintreeWeb { * // { total: { }, countryCode: 'US', currencyCode: 'USD', merchantCapabilities: [ ], supportedNetworks: [ ] } * */ - public createPaymentRequest(paymentRequest: ApplePayPaymentRequest): ApplePayPaymentRequest + createPaymentRequest(paymentRequest: ApplePayPaymentRequest): ApplePayPaymentRequest /** * Validates the merchant website, as required by ApplePaySession before payment can be authorized. @@ -302,7 +272,7 @@ declare namespace BraintreeWeb { * }; * }); */ - public performValidation(options: { validationURL: string, displayName?: string, merchantIdentifier?: string }, callback: callback): void; + performValidation(options: { validationURL: string, displayName?: string, merchantIdentifier?: string }, callback: callback): void; /** * Tokenizes an Apple Pay payment. @@ -332,16 +302,14 @@ declare namespace BraintreeWeb { * }; * }); */ - public tokenize(options: { token: any }, callback: callback): void; - + tokenize(options: { token: any }, callback: callback): void; } } /** @module braintree-web/client */ -declare namespace BraintreeWeb { +declare namespace braintree { /** * This object is returned by {@link Client#getConfiguration|getConfiguration}. This information is used extensively by other Braintree modules to properly configure themselves. - * @typedef {object} Client~configuration * @property {object} client The braintree-web/client parameters. * @property {string} client.authorization A tokenizationKey or clientToken. * @property {object} gatewayConfiguration Gateway-supplied configuration. @@ -398,30 +366,13 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {Client~configuration} configuration Options - * @description Do not use this constructor directly. Use {@link module:braintree-web/client.create|braintree.client.create} instead. - * @classdesc This class is required by many other Braintree components. It serves as the base API layer that communicates with our servers. It is also capable of being used to formulate direct calls to our servers, such as direct credit card tokenization. See {@link Client#request}. - */ - export class Client { - /** - * @class - * @param {Client~configuration} configuration Options - * @description Do not use this constructor directly. Use {@link module:braintree-web/client.create|braintree.client.create} instead. - * @classdesc This class is required by many other Braintree components. It serves as the base API layer that communicates with our servers. It is also capable of being used to formulate direct calls to our servers, such as direct credit card tokenization. See {@link Client#request}. - */ - constructor(configuration: Configuration); - /** * Returns a copy of the configuration values. * @public * @returns {Client~configuration} configuration */ - public getConfiguration(): Configuration; + getConfiguration(): Configuration; /** * Used by other modules to formulate all network requests to the Braintree gateway. It is also capable of being used directly from your own form to tokenize credit card information. However, be sure to satisfy PCI compliance if you use direct card tokenization. @@ -470,13 +421,12 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public request(options: { method: string, endpoint: string, data: any, timeout?: number }, callback: callback): void; - + request(options: { method: string, endpoint: string, data: any, timeout?: number }, callback: callback): void; } } /** @module braintree-web/data-collector */ -declare namespace BraintreeWeb { +declare namespace braintree { export interface DataCollector { /** * @static @@ -496,24 +446,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @global - * @name DataCollector - * @description Do not use this constructor directly. Use {@link module:braintree-web/data-collector.create|braintree-web.data-collector.create} instead. - * @classdesc This class is used for advanced fraud integration with PayPal and Kount. Instances of this class have {@link DataCollector#deviceData|deviceData} which is used to correlate user sessions with server transactions. Before using DataCollector, make sure you have enabled advanced fraud protection in the Braintree gateway. To use your own Kount ID, contact our support team ([support@braintreepayments.com](mailto:support@braintreepayments.com) or [877.434.2894](tel:877.434.2894)). - */ - export class DataCollector { - /** - * @class - * @global - * @name DataCollector - * @description Do not use this constructor directly. Use {@link module:braintree-web/data-collector.create|braintree-web.data-collector.create} instead. - * @classdesc This class is used for advanced fraud integration with PayPal and Kount. Instances of this class have {@link DataCollector#deviceData|deviceData} which is used to correlate user sessions with server transactions. - */ - constructor(); /** * @memberof DataCollector @@ -534,12 +466,11 @@ declare namespace BraintreeWeb { * @returns {void} */ teardown(callback?: callback): void; - } } /** @module braintree-web/hosted-fields */ -declare namespace BraintreeWeb { +declare namespace braintree { /** * Fields used in {@link module:braintree-web/hosted-fields~fieldOptions fields options} * @typedef {object} field @@ -578,7 +509,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} HostedFields~hostedFieldsCard * @description Information about the card type, sent in {@link HostedFields~stateObject|stateObjects}. * @property {string} type The code-friendly representation of the card type. It will be one of the following strings: * - `american-express` @@ -618,7 +548,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} HostedFields~hostedFieldsFieldData * @description Data about Hosted Fields fields, sent in {@link HostedFields~stateObject|stateObjects}. * @property {HTMLElement} container Reference to the container DOM element on your page associated with the current event. * @property {boolean} isFocused Whether or not the input is currently focused. @@ -641,7 +570,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} HostedFields~stateObject * @description The event payload sent from {@link HostedFields#on|on} or {@link HostedFields#getState|getState}. * @property {HostedFields~hostedFieldsCard[]} cards * This will return an array of potential {@link HostedFields~hostedFieldsCard|cards}. If the card type has been determined, the array will contain only one card. @@ -679,7 +607,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} HostedFields~tokenizePayload * @property {string} nonce The payment method nonce. * @property {object} details Additional account details. * @property {string} details.cardType Type of card, ex: Visa, MasterCard. @@ -781,22 +708,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class HostedFields - * @param {object} options The Hosted Fields {@link module:braintree-web/hosted-fields.create create} options. - * @description Do not use this constructor directly. Use {@link module:braintree-web/hosted-fields.create|braintree-web.hosted-fields.create} instead. - * @classdesc This class represents a Hosted Fields component produced by {@link module:braintree-web/hosted-fields.create|braintree-web/hosted-fields.create}. Instances of this class have methods for interacting with the input fields within Hosted Fields' iframes. - */ - export class HostedFields { - /** - * @class HostedFields - * @param {object} options The Hosted Fields {@link module:braintree-web/hosted-fields.create create} options. - * @description Do not use this constructor directly. Use {@link module:braintree-web/hosted-fields.create|braintree-web.hosted-fields.create} instead. - * @classdesc This class represents a Hosted Fields component produced by {@link module:braintree-web/hosted-fields.create|braintree-web/hosted-fields.create}. Instances of this class have methods for interacting with the input fields within Hosted Fields' iframes. - */ - constructor(options: any); /** * @name HostedFields#on @@ -829,7 +740,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public teardown(callback?: callback): void; + teardown(callback?: callback): void; /** * Tokenizes fields and returns a nonce payload. @@ -872,7 +783,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public tokenize(options?: { vault: boolean }, callback?: callback): void; + tokenize(options?: { vault: boolean }, callback?: callback): void; /** * Add a class to a {@link module:braintree-web/hosted-fields~field field}. Useful for updating field styles when events occur elsewhere in your checkout. @@ -889,7 +800,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public addClass(field: string, classname: string, callback?: callback): void; + addClass(field: string, classname: string, callback?: callback): void; /** * Removes a class to a {@link module:braintree-web/hosted-fields~field field}. Useful for updating field styles when events occur elsewhere in your checkout. @@ -910,7 +821,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public removeClass(field: string, classname: string, callback?: callback): void; + removeClass(field: string, classname: string, callback?: callback): void; /** * Sets the placeholder of a {@link module:braintree-web/hosted-fields~field field}. @@ -940,7 +851,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public setPlaceholder(field: string, placeholder: string, callback?: callback): void; + setPlaceholder(field: string, placeholder: string, callback?: callback): void; /** * Clear the value of a {@link module:braintree-web/hosted-fields~field field}. @@ -960,7 +871,7 @@ declare namespace BraintreeWeb { * hostedFieldsInstance.clear('cvv'); * hostedFieldsInstance.clear('expirationDate'); */ - public clear(field: string, callback?: callback): void; + clear(field: string, callback?: callback): void; /** * Returns an {@link HostedFields~stateObject|object} that includes the state of all fields and possible card types. @@ -973,14 +884,13 @@ declare namespace BraintreeWeb { * return state.fields[key].isValid; * }); */ - public getState(): any; + getState(): any; } } /** @module braintree-web/paypal */ -declare namespace BraintreeWeb { +declare namespace braintree { /** - * @typedef {object} PayPal~tokenizeReturn * @property {Function} close A handle to close the PayPal checkout flow. */ interface PayPalTokenizeReturn { @@ -988,7 +898,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} PayPal~tokenizePayload * @property {string} nonce The payment method nonce. * @property {string} type The payment method type, always `PayPalAccount`. * @property {object} details Additional PayPal account details. @@ -1082,20 +991,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options see {@link module:braintree-web/paypal.create|paypal.create} - * @classdesc This class represents a PayPal component. Instances of this class have methods for launching auth dialogs and other programmatic interactions with the PayPal component. - */ - export class PayPal { - /** - * @class - * @param {object} options see {@link module:braintree-web/paypal.create|paypal.create} - * @classdesc This class represents a PayPal component. Instances of this class have methods for launching auth dialogs and other programmatic interactions with the PayPal component. - */ - constructor(options: any); /** * Launches the PayPal login flow and returns a nonce payload. Only one PayPal login flow should be active at a time. One way to achieve this is to disable your PayPal button while the flow is open. @@ -1192,7 +1087,7 @@ declare namespace BraintreeWeb { * }); * @returns {PayPal~tokenizeReturn} A handle to close the PayPal checkout frame. */ - public tokenize(options: { flow: string, intent: string, offerCredit: boolean, useraction: string, amount: (string | number), currency: string, displayName: string, locale: string, enableShippingAddress: boolean, shippingAddressOverride: PayPalShippingAddress, shippingAddressEditable: boolean, billingAgreementDescription: string }, callback: callback): PayPalTokenizeReturn; + tokenize(options: { flow: string, intent: string, offerCredit: boolean, useraction: string, amount: (string | number), currency: string, displayName: string, locale: string, enableShippingAddress: boolean, shippingAddressOverride: PayPalShippingAddress, shippingAddressEditable: boolean, billingAgreementDescription: string }, callback: callback): PayPalTokenizeReturn; /** * Cleanly tear down anything set up by {@link module:braintree-web/paypal.create|create}. @@ -1200,15 +1095,13 @@ declare namespace BraintreeWeb { * @param {callback} [callback] Called once teardown is complete. No data is returned if teardown completes successfully. * @returns {void} */ - public teardown(callback?: () => void): void; - + teardown(callback?: () => void): void; } } /** @module braintree-web/three-d-secure */ -declare namespace BraintreeWeb { +declare namespace braintree { /** - * @typedef {object} ThreeDSecure~verifyPayload * @property {string} nonce The new payment method nonce produced by the 3D Secure lookup. The original nonce passed into {@link ThreeDSecure#verifyCard|verifyCard} was consumed. This new nonce should be used to transact on your server. * @property {object} details Additional account details. * @property {string} details.cardType Type of card, ex: Visa, MasterCard. @@ -1250,23 +1143,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options 3D Secure {@link module:braintree-web/three-d-secure.create create} options - * @description Do not use this constructor directly. Use {@link module:braintree-web/three-d-secure.create|braintree.threeDSecure.create} instead. - * @classdesc This class represents a ThreeDSecure component produced by {@link module:braintree-web/three-d-secure.create|braintree.threeDSecure.create}. Instances of this class have a method for launching a 3D Secure authentication flow. - */ - export class ThreeDSecure { - /** - * @class - * @param {object} options 3D Secure {@link module:braintree-web/three-d-secure.create create} options - * @description Do not use this constructor directly. Use {@link module:braintree-web/three-d-secure.create|braintree.threeDSecure.create} instead. - * @classdesc This class represents a ThreeDSecure component produced by {@link module:braintree-web/three-d-secure.create|braintree.threeDSecure.create}. Instances of this class have a method for launching a 3D Secure authentication flow. - */ - constructor(options: any); - /** * @callback ThreeDSecure~addFrameCallback @@ -1329,7 +1205,7 @@ declare namespace BraintreeWeb { * } * }); */ - public verifyCard(options: { nonce: string, amount: number, addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void, removeFrame: () => void }, callback: callback): void; + verifyCard(options: { nonce: string, amount: number, addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void, removeFrame: () => void }, callback: callback): void; /** * Cancel the 3DS flow and return the verification payload if available. @@ -1349,7 +1225,7 @@ declare namespace BraintreeWeb { * verifyPayload.liabilityShiftPossible; // boolean * }); */ - public cancelVerifyCard(callback: callback): void; + cancelVerifyCard(callback: callback): void; /** * Cleanly tear down anything set up by {@link module:braintree-web/three-d-secure.create|create} @@ -1357,7 +1233,7 @@ declare namespace BraintreeWeb { * @param {errback} [callback] Called once teardown is complete. No data is returned if teardown completes successfully. * @returns {void} */ - public teardown(callback?: callback): void; + teardown(callback?: callback): void; } } @@ -1365,9 +1241,8 @@ declare namespace BraintreeWeb { * @module braintree-web/unionpay * @description This module allows you to accept UnionPay payments. *It is currently in beta and is subject to change.* */ -declare namespace BraintreeWeb { +declare namespace braintree { /** - * @typedef {object} UnionPay~tokenizePayload * @property {string} nonce The payment method nonce. * @property {string} type Always CreditCard. * @property {object} details Additional account details: @@ -1388,7 +1263,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} UnionPay~enrollPayload * @property {string} enrollmentId UnionPay enrollment ID. This value should be passed to `tokenize`. * @property {boolean} smsCodeRequired UnionPay `smsCodeRequired` flag. *

true - the user will receive an SMS code that needs to be supplied for tokenization. @@ -1400,7 +1274,6 @@ declare namespace BraintreeWeb { } /** - * @typedef {object} UnionPay~fetchCapabilitiesPayload * @property {boolean} isUnionPay Determines if this card is a UnionPay card. * @property {boolean} isDebit Determines if this card is a debit card. This property is only present if `isUnionPay` is `true`. * @property {object} unionPay UnionPay specific properties. This property is only present if `isUnionPay` is `true`. @@ -1443,22 +1316,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options See {@link module:braintree-web/unionpay.create|unionpay.create}. - * @description You cannot use this constructor directly. Use {@link module:braintree-web/unionpay.create|braintree-web.unionpay.create} instead. - * @classdesc This class represents a UnionPay component. Instances of this class have methods for {@link UnionPay#fetchCapabilities fetching capabilities} of UnionPay cards, {@link UnionPay#enroll enrolling} a UnionPay card, and {@link UnionPay#tokenize tokenizing} a UnionPay card. - */ - export class UnionPay { - /** - * @class - * @param {object} options See {@link module:braintree-web/unionpay.create|unionpay.create}. - * @description You cannot use this constructor directly. Use {@link module:braintree-web/unionpay.create|braintree-web.unionpay.create} instead. - * @classdesc This class represents a UnionPay component. Instances of this class have methods for {@link UnionPay#fetchCapabilities fetching capabilities} of UnionPay cards, {@link UnionPay#enroll enrolling} a UnionPay card, and {@link UnionPay#tokenize tokenizing} a UnionPay card. - */ - constructor(options: any); /** * Fetches the capabilities of a card, including whether or not the SMS enrollment process is required. @@ -1531,7 +1388,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public fetchCapabilities(options: { card: any, hostedFields: HostedFields }, callback: callback): void; + fetchCapabilities(options: { card: any, hostedFields: HostedFields }, callback: callback): void; /** * Enrolls a UnionPay card. Use {@link UnionPay#fetchCapabilities|fetchCapabilities} to determine if the SMS enrollment process is required. @@ -1594,7 +1451,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public enroll(options: { card: any, hostedFields: HostedFields, mobile: any }, callback: callback): void; + enroll(options: { card: any, hostedFields: HostedFields, mobile: any }, callback: callback): void; /** * Tokenizes a UnionPay card and returns a nonce payload. @@ -1643,7 +1500,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public tokenize(options: { card: any, hostedFields: HostedFields, enrollmentId: string, smsCode: string }, callback: callback): void; + tokenize(options: { card: any, hostedFields: HostedFields, enrollmentId: string, smsCode: string }, callback: callback): void; /** * Cleanly tear down anything set up by {@link module:braintree-web/unionpay.create|create}. This only needs to be called when using UnionPay with Hosted Fields. @@ -1659,8 +1516,7 @@ declare namespace BraintreeWeb { * }); * @returns {void} */ - public teardown(callback?: callback): void; - + teardown(callback?: callback): void; } /** @@ -1683,21 +1539,6 @@ declare namespace BraintreeWeb { * @type {string} */ VERSION: string; - } - - /** - * @class - * @param {object} options See {@link module:braintree-web/us-bank-account.create|us-bank-account.create}. - * @classdesc This class represents a US Bank Account component. Instances of this class can tokenize raw bank details or present a bank login. You cannot use this constructor directly. Use {@link module:braintree-web/us-bank-account.create|braintree.us-bank-account.create} instead. - */ - export class USBankAccount { - /** - * @class - * @param {object} options See {@link module:braintree-web/us-bank-account.create|us-bank-account.create}. - * @classdesc This class represents a US Bank Account component. Instances of this class can tokenize raw bank details or present a bank login. You cannot use this constructor directly. Use {@link module:braintree-web/us-bank-account.create|braintree.us-bank-account.create} instead. - */ - constructor(options: any) - /** * Tokenizes bank information to return a payment method nonce. You can tokenize bank details by providing information like account and routing numbers. You can also tokenize with a bank login UI that prompts the customer to log into their bank account. @@ -1778,7 +1619,7 @@ declare namespace BraintreeWeb { * }); * }); */ - public tokenize(options: { mandateText: string, bankDetails: any, bankLogin: any }, callback: callback): void; + tokenize(options: { mandateText: string, bankDetails: any, bankLogin: any }, callback: callback): void; /** * Cleanly tear down anything set up by {@link module:braintree-web/us-bank-account.create|create}. @@ -1786,77 +1627,53 @@ declare namespace BraintreeWeb { * @param {callback} [callback] Called once teardown is complete. No data is returned if teardown completes successfully. * @returns {void} */ - public teardown(callback?: callback): void; - - } - -} - -declare namespace BraintreeError { - /** - * Enum for {@link BraintreeError} types. - * @name BraintreeError.types - * @enum - * @readonly - * @memberof BraintreeError - * @property {string} CUSTOMER An error caused by the customer. - * @property {string} MERCHANT An error that is actionable by the merchant. - * @property {string} NETWORK An error due to a network problem. - * @property {string} INTERNAL An error caused by Braintree code. - * @property {string} UNKNOWN An error where the origin is unknown. - */ - export enum Types { - CUSTOMER, - MERCHANT, - NETWORK, - INTERNAL, - UNKNOWN + teardown(callback?: callback): void; } } -/** - * @class - * @global - * @param {object} options Construction options - * @classdesc This class is used to report error conditions, frequently as the first parameter to callbacks throughout the Braintree SDK. - * @description You cannot use this constructor directly. Interact with instances of this class through {@link callback callbacks}. - */ -declare class BraintreeError { - /** - * @class - * @global - * @param {object} options Construction options - * @classdesc This class is used to report error conditions, frequently as the first parameter to callbacks throughout the Braintree SDK. - * @description You cannot use this constructor directly. Interact with instances of this class through {@link callback callbacks}. - */ - constructor(options: any); +declare namespace braintree { + export namespace BraintreeError { + /** + * Enum for {@link BraintreeError} types. + * @name BraintreeError.types + * @enum + * @readonly + * @memberof BraintreeError + * @property {string} CUSTOMER An error caused by the customer. + * @property {string} MERCHANT An error that is actionable by the merchant. + * @property {string} NETWORK An error due to a network problem. + * @property {string} INTERNAL An error caused by Braintree code. + * @property {string} UNKNOWN An error where the origin is unknown. + */ + export type Types = "CUSTOMER" | "MERCHANT" | "NETWORK" | "INTERNAL" | "UNKNOWN"; + } - /** - * @type {string} - * @description A code that corresponds to specific errors. - */ - code: string; + export interface BraintreeError { + /** + * @type {string} + * @description A code that corresponds to specific errors. + */ + code: string; - /** - * @type {string} - * @description A short description of the error. - */ - message: string; + /** + * @type {string} + * @description A short description of the error. + */ + message: string; - /** - * @type {BraintreeError.types} - * @description The type of error. - */ - type: BraintreeError.Types; + /** + * @type {BraintreeError.types} + * @description The type of error. + */ + type: BraintreeError.Types; - /** - * @type {object=} - * @description Additional information about the error, such as an underlying network error response. - */ - details: any; -} + /** + * @type {object=} + * @description Additional information about the error, such as an underlying network error response. + */ + details: any; + } -declare namespace BraintreeWeb { /** * @global * @callback callback @@ -1895,39 +1712,40 @@ declare namespace BraintreeWeb { * braintreeClient.create(...); * }); */ -interface BraintreeStatic { +declare namespace braintree { /** @type {module:braintree-web/client} */ - client: BraintreeWeb.Client; + export var client: braintree.Client; /** @type {module:braintree-web/paypal} */ - paypal: BraintreeWeb.PayPal; + export var paypal: braintree.PayPal; /** @type {module:braintree-web/hosted-fields} */ - hostedFields: BraintreeWeb.HostedFields; + export var hostedFields: braintree.HostedFields; /** @type {module:braintree-web/three-d-secure} */ - threeDSecure: BraintreeWeb.ThreeDSecure; + export var threeDSecure: braintree.ThreeDSecure; /** @type {module:braintree-web/data-collector} */ - dataCollector: BraintreeWeb.DataCollector; + export var dataCollector: braintree.DataCollector; /** @type {module:braintree-web/american-express} */ - americanExpress: BraintreeWeb.AmericanExpress; + export var americanExpress: braintree.AmericanExpress; /** @type {module:braintree-web/unionpay} */ - unionpay: BraintreeWeb.UnionPay; + export var unionpay: braintree.UnionPay; /** @type {module:braintree-web/apple-pay} */ - applePay: BraintreeWeb.ApplePay; + export var applePay: braintree.ApplePay; - /** @type {module:braintree-web/us-bank-account} */ - usBankAccount: BraintreeWeb.USBankAccount; + /** @type {module:braintree-web/us-bank-account} */ + export var usBankAccount: braintree.USBankAccount; /** * @description The current version of the SDK, i.e. `3.0.2`. * @type {string} */ - VERSION: string; + export var VERSION: string; } -declare var braintree: BraintreeStatic; +export = braintree; +export as namespace braintree; diff --git a/types/braintree-web/test/node.ts b/types/braintree-web/test/node.ts new file mode 100644 index 0000000000..9eed5b228d --- /dev/null +++ b/types/braintree-web/test/node.ts @@ -0,0 +1,440 @@ +import * as braintree from 'braintree-web'; + +let version: string = braintree.VERSION; + +let clientToken: string = "eyJ2ZXJzaW9uIjoyLCJhdXRob3JpemF0aW9uRmluZ2VycHJpbnQiOiI0YjlhYzVmYmI4ZTNkYzQzMmFkZjJhNzBlNjZlMWNjY2M5ODRkYzE4ZTM4YmY4NjYzZTM5NjM3NWZjYmQzY2U5fGNyZWF0ZWRfYXQ9MjAxNi0wOS0wOFQwNTowMzo0MC4xNjk1NTUwMzUrMDAwMFx1MDAyNm1lcmNoYW50X2lkPTM0OHBrOWNnZjNiZ3l3MmJcdTAwMjZwdWJsaWNfa2V5PTJuMjQ3ZHY4OWJxOXZtcHIiLCJjb25maWdVcmwiOiJodHRwczovL2FwaS5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tOjQ0My9tZXJjaGFudHMvMzQ4cGs5Y2dmM2JneXcyYi9jbGllbnRfYXBpL3YxL2NvbmZpZ3VyYXRpb24iLCJjaGFsbGVuZ2VzIjpbXSwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwiY2xpZW50QXBpVXJsIjoiaHR0cHM6Ly9hcGkuc2FuZGJveC5icmFpbnRyZWVnYXRld2F5LmNvbTo0NDMvbWVyY2hhbnRzLzM0OHBrOWNnZjNiZ3l3MmIvY2xpZW50X2FwaSIsImFzc2V0c1VybCI6Imh0dHBzOi8vYXNzZXRzLmJyYWludHJlZWdhdGV3YXkuY29tIiwiYXV0aFVybCI6Imh0dHBzOi8vYXV0aC52ZW5tby5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tIiwiYW5hbHl0aWNzIjp7InVybCI6Imh0dHBzOi8vY2xpZW50LWFuYWx5dGljcy5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tLzM0OHBrOWNnZjNiZ3l3MmIifSwidGhyZWVEU2VjdXJlRW5hYmxlZCI6dHJ1ZSwicGF5cGFsRW5hYmxlZCI6dHJ1ZSwicGF5cGFsIjp7ImRpc3BsYXlOYW1lIjoiQWNtZSBXaWRnZXRzLCBMdGQuIChTYW5kYm94KSIsImNsaWVudElkIjpudWxsLCJwcml2YWN5VXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3BwIiwidXNlckFncmVlbWVudFVybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS90b3MiLCJiYXNlVXJsIjoiaHR0cHM6Ly9hc3NldHMuYnJhaW50cmVlZ2F0ZXdheS5jb20iLCJhc3NldHNVcmwiOiJodHRwczovL2NoZWNrb3V0LnBheXBhbC5jb20iLCJkaXJlY3RCYXNlVXJsIjpudWxsLCJhbGxvd0h0dHAiOnRydWUsImVudmlyb25tZW50Tm9OZXR3b3JrIjp0cnVlLCJlbnZpcm9ubWVudCI6Im9mZmxpbmUiLCJ1bnZldHRlZE1lcmNoYW50IjpmYWxzZSwiYnJhaW50cmVlQ2xpZW50SWQiOiJtYXN0ZXJjbGllbnQzIiwiYmlsbGluZ0FncmVlbWVudHNFbmFibGVkIjp0cnVlLCJtZXJjaGFudEFjY291bnRJZCI6ImFjbWV3aWRnZXRzbHRkc2FuZGJveCIsImN1cnJlbmN5SXNvQ29kZSI6IlVTRCJ9LCJjb2luYmFzZUVuYWJsZWQiOmZhbHNlLCJtZXJjaGFudElkIjoiMzQ4cGs5Y2dmM2JneXcyYiIsInZlbm1vIjoib2ZmIn0="; + +braintree.client.create({ + authorization: clientToken +}, function (error: braintree.BraintreeError, clientInstance: any) { + + var form: HTMLFormElement = document.getElementById('my-form-id') as HTMLFormElement; + var data: { creditCard: braintree.CreditCardInfo } = { + creditCard: { + number: form['cc-number'].value, + cvv: form['cc-cvv'].value, + expirationDate: form['cc-date'].value, + billingAddress: { + postalCode: form['cc-postal'].value + } + } + }; + + clientInstance.request({ + endpoint: 'payment_methods/credit_cards', + method: 'post', + data: data + }, function (requestErr: braintree.BraintreeError, response: { creditCards: any[]; }) { + if (requestErr) { throw new Error(requestErr.message); } + + console.log('Got nonce:', response.creditCards[0].nonce); + }); + + braintree.hostedFields.create({ + client: clientInstance, + styles: { + 'input': { + 'font-size': '16pt', + 'color': '#3A3A3A' + }, + + '.number': { + 'font-family': 'monospace' + }, + '.valid': { + 'color': 'green' + } + }, + fields: { + number: { + selector: '#card-number' + }, + cvv: { + selector: '#cvv', + type: 'password' + }, + expirationMonth: { + selector: '#expiration-month', + select: { + options: ["01 - Jan", "02 - Feb", "03 - Mar", "04 - Apr", "05 - May", "06 - Jun", "07 - Jul", "08 - Aug", "09 - Sep", "10 - Oct", "11 - Nov", "12 - Dec"] + } + }, + expirationYear: { + selector: '#expiration-year', + select: true + } + } + }, function (hostedFieldsErr?: braintree.BraintreeError, hostedFieldsInstance?: any) { + + if (hostedFieldsErr) { + // Handle error in Hosted Fields creation + console.log(`Error Code: ${error.code}, Type: ${error.type}, Message: ${error.message}, Details: ${error.details}`); + return; + } + + let form = new HTMLFormElement(); + + form.addEventListener('submit', function (event: Event) { + event.preventDefault(); + + hostedFieldsInstance.tokenize(function (tokenizeErr: braintree.BraintreeError, payload: braintree.HostedFieldsTokenizePayload) { + if (tokenizeErr) { + // Handle error in Hosted Fields tokenization + switch (tokenizeErr.code) { + case 'HOSTED_FIELDS_FIELDS_EMPTY': + console.error('All fields are empty! Please fill out the form.'); + break; + case 'HOSTED_FIELDS_FIELDS_INVALID': + console.error('Some fields are invalid:', tokenizeErr.details.invalidFieldKeys); + break; + case 'HOSTED_FIELDS_FAILED_TOKENIZATION': + console.error('Tokenization failed server side. Is the card valid?'); + break; + case 'HOSTED_FIELDS_TOKENIZATION_NETWORK_ERROR': + console.error('Network error occurred when tokenizing.'); + break; + default: + console.error('Something bad happened!', tokenizeErr); + } + return; + } + + // Put `payload.nonce` into the `payment-method-nonce` input, and then + // submit the form. Alternatively, you could send the nonce to your server + // with AJAX. + (document.querySelector('input[name="payment-method-nonce"]') as HTMLInputElement).value = payload.nonce; + form.submit(); + }); + }, false); + + hostedFieldsInstance.on('focus', function (event: braintree.HostedFieldsStateObject) { + console.log(event.emittedBy, 'has been focused'); + }); + + hostedFieldsInstance.teardown(function (teardownErr: braintree.BraintreeError) { + if (teardownErr) { + console.error('Could not tear down Hosted Fields!'); + } else { + console.info('Hosted Fields has been torn down!'); + } + }); + + hostedFieldsInstance.tokenize({ + vault: true + }, function (tokenizeErr: braintree.BraintreeError, payload: braintree.HostedFieldsTokenizePayload) { + if (tokenizeErr) { + console.error(tokenizeErr); + } else { + console.log('Got nonce:', payload.nonce); + } + }); + + hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: braintree.BraintreeError) { + if (addClassErr) { + console.error(addClassErr); + } + }); + + hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: braintree.BraintreeError) { + if (addClassErr) { + console.error(addClassErr); + return; + } + + // some time later... + hostedFieldsInstance.removeClass('number', 'custom-class'); + }); + + hostedFieldsInstance.setPlaceholder('number', '4111 1111 1111 1111', function (placeholderErr: braintree.BraintreeError) { + if (placeholderErr) { + console.error(placeholderErr); + } + }); + + hostedFieldsInstance.on('cardTypeChange', function (event: braintree.HostedFieldsStateObject) { + // Update the placeholder value if there is only one possible card type + if (event.cards.length === 1) { + braintree.hostedFields.setPlaceholder('cvv', event.cards[0].code.name, function (placeholderErr: braintree.BraintreeError) { + if (placeholderErr) { + // Handle errors, such as invalid field name + console.error(placeholderErr); + } + }); + } + }); + + hostedFieldsInstance.clear('number', function (clearErr: braintree.BraintreeError) { + if (clearErr) { + console.error(clearErr); + } + }); + + hostedFieldsInstance.clear('number'); + hostedFieldsInstance.clear('cvv'); + hostedFieldsInstance.clear('expirationDate'); + + var state = braintree.hostedFields.getState(); + + var formValid = Object.keys(state.fields).every(function (key) { + return state.fields[key].isValid; + }); + }); + + braintree.applePay.create({ client: clientInstance }, function (createErr?: braintree.BraintreeError, applePayInstance?: any) { + if (createErr) { + // Handle error in client creation + console.log(`Error Code: ${error.code}, Type: ${error.type}, Message: ${error.message}, Details: ${error.details}`); + + return; + } + + let request = { + countryCode: 'US', + currencyCode: 'USD', + supportedNetworks: ['visa', 'masterCard'], + merchantCapabilities: ['supports3DS'], + total: { label: 'Your Label', amount: '10.00' }, + }; + + var paymentRequest = braintree.applePay.createPaymentRequest(request); + + console.log(paymentRequest); + // { total: { }, countryCode: 'US', currencyCode: 'USD', merchantCapabilities: [ ], supportedNetworks: [ ] } + }); + + braintree.applePay.create({ client: clientInstance }, function (createErr, applePayInstance) { + let request = { + countryCode: 'US', + currencyCode: 'USD', + supportedNetworks: ['visa', 'masterCard'], + merchantCapabilities: ['supports3DS'], + total: { label: 'Your Label', amount: '10.00' }, + }; + + var session = new braintree.ApplePaySession(1, request); + + session.onvalidatemerchant = function (event: { validationURL: string }) { + braintree.applePay.performValidation({ + validationURL: event.validationURL + }, function (err, validationData) { + if (err) { + console.error(err); + session.abort(); + return; + } + session.completeMerchantValidation(validationData); + }); + }; + }); + + braintree.applePay.create({ client: clientInstance }, function (createErr, applePayInstance) { + let request = { + countryCode: 'US', + currencyCode: 'USD', + supportedNetworks: ['visa', 'masterCard'], + merchantCapabilities: ['supports3DS'], + total: { label: 'Your Label', amount: '10.00' }, + }; + + var session = new braintree.ApplePaySession(1, request); + + session.onpaymentauthorized = function (event) { + braintree.applePay.tokenize({ + token: event.payment.token + }, function (err, tokenizedPayload) { + if (err) { + session.completePayment(braintree.ApplePayStatusCodes.STATUS_FAILURE); + return; + } + session.completePayment(braintree.ApplePayStatusCodes.STATUS_SUCCESS); + + // Send the tokenizedPayload to your server. + }); + }; + }); + + braintree.paypal.create({ + client: clientInstance + }, function (createErr, paypalInstance) { + if (createErr) { + if (createErr.code === 'PAYPAL_BROWSER_NOT_SUPPORTED') { + console.error('This browser is not supported.'); + } else { + console.error('Error!', createErr); + } + } + + let button = new HTMLButtonElement(); + + button.addEventListener('click', function () { + // Disable the button so that we don't attempt to open multiple popups. + button.setAttribute('disabled', 'disabled'); + + // Because PayPal tokenization opens a popup, this must be called + // as a result of a user action, such as a button click. + paypalInstance.tokenize({ + flow: 'vault' // Required + // Any other tokenization options + }, function (tokenizeErr: braintree.BraintreeError, payload: braintree.PayPalTokenizePayload) { + button.removeAttribute('disabled'); + + if (tokenizeErr) { + // Handle tokenization errors or premature flow closure + + switch (tokenizeErr.code) { + case 'PAYPAL_POPUP_CLOSED': + console.error('Customer closed PayPal popup.'); + break; + case 'PAYPAL_ACCOUNT_TOKENIZATION_FAILED': + console.error('PayPal tokenization failed. See details:', tokenizeErr.details); + break; + case 'PAYPAL_FLOW_FAILED': + console.error('Unable to initialize PayPal flow. Are your options correct?', tokenizeErr.details); + break; + default: + console.error('Error!', tokenizeErr); + } + } else { + // Submit payload.nonce to your server + } + }); + }); + }); + + braintree.unionpay.create({ client: clientInstance }, function (createErr, unionpayInstance) { + if (createErr) { + console.error(createErr); + return; + } + + unionpayInstance.fetchCapabilities({ + card: { + number: '4111111111111111' + } + }, function (fetchErr: braintree.BraintreeError, cardCapabilities: braintree.UnionPayFetchCapabilitiesPayload) { + if (fetchErr) { + console.error(fetchErr); + return; + } + + if (cardCapabilities.isUnionPay) { + if (cardCapabilities.unionPay && !cardCapabilities.unionPay.isSupported) { + // Braintree cannot process this UnionPay card. + // Ask the user for a different card. + return; + } + + if (cardCapabilities.isDebit) { + // CVV and expiration date are not required + } else { + // CVV and expiration date are required + } + + // Show mobile phone number field for enrollment + } + }); + + unionpayInstance.enroll({ + card: { + number: '4111111111111111', + expirationMonth: '12', + expirationYear: '2038' + }, + mobile: { + countryCode: '62', + number: '111111111111' + } + }, function (enrollErr: braintree.BraintreeError, response: braintree.UnionPayEnrollPayload) { + if (enrollErr) { + console.error(enrollErr); + return; + } + + if (response.smsCodeRequired) { + // If smsCodeRequired, wait for SMS auth code from customer + // Then use response.enrollmentId during {@link UnionPay#tokenize} + } else { + // SMS code is not required from the user. + // {@link UnionPay#tokenize} can be called immediately + } + }); + + let enrollResponse: { + enrollmentId: string + }; + + unionpayInstance.tokenize({ + card: { + number: '4111111111111111', + expirationMonth: '12', + expirationYear: '2038', + cvv: '123' + }, + enrollmentId: enrollResponse.enrollmentId, // Returned from enroll + smsCode: '11111' // Received by customer's phone, if SMS enrollment was required. Otherwise it should be omitted + }, function (tokenizeErr: braintree.BraintreeError, response: braintree.UnionPayTokenizePayload) { + if (tokenizeErr) { + console.error(tokenizeErr); + return; + } + + // Send response.nonce to your server + }); + + unionpayInstance.teardown(function (teardownErr: braintree.BraintreeError) { + if (teardownErr) { + console.error('Could not tear down UnionPay.'); + } else { + console.log('UnionPay has been torn down.'); + } + }); + }); +}); + +let existingNonce = "fake-valid-nonce"; +let submitNonceToServer: (nonce: string) => void; + +braintree.threeDSecure.verifyCard({ + nonce: existingNonce, + amount: 123.45, + addFrame: function (err, iframe) { + // Set up your UI and add the iframe. + let my3DSContainer = document.createElement('div'); + my3DSContainer.appendChild(iframe); + document.body.appendChild(my3DSContainer); + }, + removeFrame: function () { + let my3DSContainer = document.createElement('div'); + + // Remove UI that you added in addFrame. + document.body.removeChild(my3DSContainer); + } +}, function (err: braintree.BraintreeError, payload: braintree.ThreeDSecureVerifyPayload) { + if (err) { + console.error(err); + return; + } + + if (payload.liabilityShifted) { + // Liablity has shifted + submitNonceToServer(payload.nonce); + } else if (payload.liabilityShiftPossible) { + // Liablity may still be shifted + // Decide if you want to submit the nonce + } else { + // Liablity has not shifted and will not shift + // Decide if you want to submit the nonce + } +}); + +braintree.threeDSecure.cancelVerifyCard(function (err: braintree.BraintreeError, verifyPayload: braintree.ThreeDSecureVerifyPayload) { + if (err) { + // Handle error + console.log(err.message); // No verification payload available + return; + } + + verifyPayload.nonce; // The nonce returned from the 3ds lookup call + verifyPayload.liabilityShifted; // boolean + verifyPayload.liabilityShiftPossible; // boolean +}); diff --git a/types/braintree-web/braintree-web-tests.ts b/types/braintree-web/test/web.ts similarity index 86% rename from types/braintree-web/braintree-web-tests.ts rename to types/braintree-web/test/web.ts index c9aee724c0..22073363d4 100644 --- a/types/braintree-web/braintree-web-tests.ts +++ b/types/braintree-web/test/web.ts @@ -4,10 +4,10 @@ let clientToken: string = "eyJ2ZXJzaW9uIjoyLCJhdXRob3JpemF0aW9uRmluZ2VycHJpbnQiO braintree.client.create({ authorization: clientToken -}, function (error: BraintreeError, clientInstance: any) { +}, function (error: braintree.BraintreeError, clientInstance: any) { var form: HTMLFormElement = document.getElementById('my-form-id') as HTMLFormElement; - var data: { creditCard: BraintreeWeb.CreditCardInfo } = { + var data: { creditCard: braintree.CreditCardInfo } = { creditCard: { number: form['cc-number'].value, cvv: form['cc-cvv'].value, @@ -22,7 +22,7 @@ braintree.client.create({ endpoint: 'payment_methods/credit_cards', method: 'post', data: data - }, function (requestErr: BraintreeError, response: { creditCards: any[]; }) { + }, function (requestErr: braintree.BraintreeError, response: { creditCards: any[]; }) { if (requestErr) { throw new Error(requestErr.message); } console.log('Got nonce:', response.creditCards[0].nonce); @@ -62,7 +62,7 @@ braintree.client.create({ select: true } } - }, function (hostedFieldsErr?: BraintreeError, hostedFieldsInstance?: any) { + }, function (hostedFieldsErr?: braintree.BraintreeError, hostedFieldsInstance?: any) { if (hostedFieldsErr) { // Handle error in Hosted Fields creation @@ -75,7 +75,7 @@ braintree.client.create({ form.addEventListener('submit', function (event: Event) { event.preventDefault(); - hostedFieldsInstance.tokenize(function (tokenizeErr: BraintreeError, payload: BraintreeWeb.HostedFieldsTokenizePayload) { + hostedFieldsInstance.tokenize(function (tokenizeErr: braintree.BraintreeError, payload: braintree.HostedFieldsTokenizePayload) { if (tokenizeErr) { // Handle error in Hosted Fields tokenization switch (tokenizeErr.code) { @@ -105,11 +105,11 @@ braintree.client.create({ }); }, false); - hostedFieldsInstance.on('focus', function (event: BraintreeWeb.HostedFieldsStateObject) { + hostedFieldsInstance.on('focus', function (event: braintree.HostedFieldsStateObject) { console.log(event.emittedBy, 'has been focused'); }); - hostedFieldsInstance.teardown(function (teardownErr: BraintreeError) { + hostedFieldsInstance.teardown(function (teardownErr: braintree.BraintreeError) { if (teardownErr) { console.error('Could not tear down Hosted Fields!'); } else { @@ -119,7 +119,7 @@ braintree.client.create({ hostedFieldsInstance.tokenize({ vault: true - }, function (tokenizeErr: BraintreeError, payload: BraintreeWeb.HostedFieldsTokenizePayload) { + }, function (tokenizeErr: braintree.BraintreeError, payload: braintree.HostedFieldsTokenizePayload) { if (tokenizeErr) { console.error(tokenizeErr); } else { @@ -127,13 +127,13 @@ braintree.client.create({ } }); - hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: BraintreeError) { + hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: braintree.BraintreeError) { if (addClassErr) { console.error(addClassErr); } }); - hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: BraintreeError) { + hostedFieldsInstance.addClass('number', 'custom-class', function (addClassErr: braintree.BraintreeError) { if (addClassErr) { console.error(addClassErr); return; @@ -143,16 +143,16 @@ braintree.client.create({ hostedFieldsInstance.removeClass('number', 'custom-class'); }); - hostedFieldsInstance.setPlaceholder('number', '4111 1111 1111 1111', function (placeholderErr: BraintreeError) { + hostedFieldsInstance.setPlaceholder('number', '4111 1111 1111 1111', function (placeholderErr: braintree.BraintreeError) { if (placeholderErr) { console.error(placeholderErr); } }); - hostedFieldsInstance.on('cardTypeChange', function (event: BraintreeWeb.HostedFieldsStateObject) { + hostedFieldsInstance.on('cardTypeChange', function (event: braintree.HostedFieldsStateObject) { // Update the placeholder value if there is only one possible card type if (event.cards.length === 1) { - braintree.hostedFields.setPlaceholder('cvv', event.cards[0].code.name, function (placeholderErr: BraintreeError) { + braintree.hostedFields.setPlaceholder('cvv', event.cards[0].code.name, function (placeholderErr: braintree.BraintreeError) { if (placeholderErr) { // Handle errors, such as invalid field name console.error(placeholderErr); @@ -161,7 +161,7 @@ braintree.client.create({ } }); - hostedFieldsInstance.clear('number', function (clearErr: BraintreeError) { + hostedFieldsInstance.clear('number', function (clearErr: braintree.BraintreeError) { if (clearErr) { console.error(clearErr); } @@ -178,7 +178,7 @@ braintree.client.create({ }); }); - braintree.applePay.create({ client: clientInstance }, function (createErr?: BraintreeError, applePayInstance?: any) { + braintree.applePay.create({ client: clientInstance }, function (createErr?: braintree.BraintreeError, applePayInstance?: any) { if (createErr) { // Handle error in client creation console.log(`Error Code: ${error.code}, Type: ${error.type}, Message: ${error.message}, Details: ${error.details}`); @@ -209,7 +209,7 @@ braintree.client.create({ total: { label: 'Your Label', amount: '10.00' }, }; - var session = new ApplePaySession(1, request); + var session = new braintree.ApplePaySession(1, request); session.onvalidatemerchant = function (event: { validationURL: string }) { braintree.applePay.performValidation({ @@ -234,17 +234,17 @@ braintree.client.create({ total: { label: 'Your Label', amount: '10.00' }, }; - var session = new ApplePaySession(1, request); + var session = new braintree.ApplePaySession(1, request); session.onpaymentauthorized = function (event) { braintree.applePay.tokenize({ token: event.payment.token }, function (err, tokenizedPayload) { if (err) { - session.completePayment(ApplePayStatusCodes.STATUS_FAILURE); + session.completePayment(braintree.ApplePayStatusCodes.STATUS_FAILURE); return; } - session.completePayment(ApplePayStatusCodes.STATUS_SUCCESS); + session.completePayment(braintree.ApplePayStatusCodes.STATUS_SUCCESS); // Send the tokenizedPayload to your server. }); @@ -273,7 +273,7 @@ braintree.client.create({ paypalInstance.tokenize({ flow: 'vault' // Required // Any other tokenization options - }, function (tokenizeErr: BraintreeError, payload: BraintreeWeb.PayPalTokenizePayload) { + }, function (tokenizeErr: braintree.BraintreeError, payload: braintree.PayPalTokenizePayload) { button.removeAttribute('disabled'); if (tokenizeErr) { @@ -309,7 +309,7 @@ braintree.client.create({ card: { number: '4111111111111111' } - }, function (fetchErr: BraintreeError, cardCapabilities: BraintreeWeb.UnionPayFetchCapabilitiesPayload) { + }, function (fetchErr: braintree.BraintreeError, cardCapabilities: braintree.UnionPayFetchCapabilitiesPayload) { if (fetchErr) { console.error(fetchErr); return; @@ -342,7 +342,7 @@ braintree.client.create({ countryCode: '62', number: '111111111111' } - }, function (enrollErr: BraintreeError, response: BraintreeWeb.UnionPayEnrollPayload) { + }, function (enrollErr: braintree.BraintreeError, response: braintree.UnionPayEnrollPayload) { if (enrollErr) { console.error(enrollErr); return; @@ -370,7 +370,7 @@ braintree.client.create({ }, enrollmentId: enrollResponse.enrollmentId, // Returned from enroll smsCode: '11111' // Received by customer's phone, if SMS enrollment was required. Otherwise it should be omitted - }, function (tokenizeErr: BraintreeError, response: BraintreeWeb.UnionPayTokenizePayload) { + }, function (tokenizeErr: braintree.BraintreeError, response: braintree.UnionPayTokenizePayload) { if (tokenizeErr) { console.error(tokenizeErr); return; @@ -379,7 +379,7 @@ braintree.client.create({ // Send response.nonce to your server }); - unionpayInstance.teardown(function (teardownErr: BraintreeError) { + unionpayInstance.teardown(function (teardownErr: braintree.BraintreeError) { if (teardownErr) { console.error('Could not tear down UnionPay.'); } else { @@ -407,7 +407,7 @@ braintree.threeDSecure.verifyCard({ // Remove UI that you added in addFrame. document.body.removeChild(my3DSContainer); } -}, function (err: BraintreeError, payload: BraintreeWeb.ThreeDSecureVerifyPayload) { +}, function (err: braintree.BraintreeError, payload: braintree.ThreeDSecureVerifyPayload) { if (err) { console.error(err); return; @@ -425,7 +425,7 @@ braintree.threeDSecure.verifyCard({ } }); -braintree.threeDSecure.cancelVerifyCard(function (err: BraintreeError, verifyPayload: BraintreeWeb.ThreeDSecureVerifyPayload) { +braintree.threeDSecure.cancelVerifyCard(function (err: braintree.BraintreeError, verifyPayload: braintree.ThreeDSecureVerifyPayload) { if (err) { // Handle error console.log(err.message); // No verification payload available @@ -435,4 +435,4 @@ braintree.threeDSecure.cancelVerifyCard(function (err: BraintreeError, verifyPay verifyPayload.nonce; // The nonce returned from the 3ds lookup call verifyPayload.liabilityShifted; // boolean verifyPayload.liabilityShiftPossible; // boolean -}); \ No newline at end of file +}); diff --git a/types/braintree-web/tsconfig.json b/types/braintree-web/tsconfig.json index abc64cd9c3..d326f77f12 100644 --- a/types/braintree-web/tsconfig.json +++ b/types/braintree-web/tsconfig.json @@ -18,6 +18,7 @@ }, "files": [ "index.d.ts", - "braintree-web-tests.ts" + "test/web.ts", + "test/node.ts" ] -} \ No newline at end of file +} diff --git a/types/camelcase-keys/camelcase-keys-tests.ts b/types/camelcase-keys/camelcase-keys-tests.ts index ed2865e9ce..099b8c4a14 100644 --- a/types/camelcase-keys/camelcase-keys-tests.ts +++ b/types/camelcase-keys/camelcase-keys-tests.ts @@ -3,8 +3,8 @@ import camelcaseKeys = require('camelcase-keys'); camelcaseKeys({'foo-bar': true}); // => {fooBar: true} -camelcaseKeys({'foo-bar': true, 'nested': {unicorn_rainbow: true}}, {deep: true}); +camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true}); // => {fooBar: true, nested: {unicornRainbow: true}} -camelcaseKeys({'_': [], 'foo-bar': true}); -// => {_: [], fooBar: true} \ No newline at end of file +camelcaseKeys({_: [], 'foo-bar': true}); +// => {_: [], fooBar: true} diff --git a/types/charm/charm-tests.ts b/types/charm/charm-tests.ts index d87a360084..09dc93184e 100644 --- a/types/charm/charm-tests.ts +++ b/types/charm/charm-tests.ts @@ -8,7 +8,8 @@ const text = 'Always after me lucky charms.'; let offset = 0; const iv = setInterval(() => { - let y = 0, dy = 1; + let y = 0; + let dy = 1; for (let i = 0; i < 40; i++) { const color = colors[(i + offset) % colors.length]; const c = text[(i + offset) % text.length]; diff --git a/types/chunked-dc/index.d.ts b/types/chunked-dc/index.d.ts index ab3acd6901..d200c07899 100644 --- a/types/chunked-dc/index.d.ts +++ b/types/chunked-dc/index.d.ts @@ -5,14 +5,13 @@ // Interfaces declare namespace chunkedDc { - - /** common.ts **/ + /** common.ts */ interface CommonStatic { HEADER_LENGTH: number; } - /** chunker.ts **/ + /** chunker.ts */ interface Chunker extends IterableIterator { hasNext: boolean; @@ -24,7 +23,7 @@ declare namespace chunkedDc { new(id: number, message: Uint8Array, chunkSize: number): Chunker; } - /** unchunker.ts **/ + /** unchunker.ts */ type MessageListener = (message: Uint8Array, context?: any) => void; @@ -38,13 +37,12 @@ declare namespace chunkedDc { new(): Unchunker; } - /** main.ts **/ + /** main.ts */ interface Standalone { Chunker: ChunkerStatic; Unchunker: UnchunkerStatic; } - } // Entry point for the packed ES5 version: diff --git a/types/clipboard/index.d.ts b/types/clipboard/index.d.ts index 5f12a41d5f..861d8c326b 100644 --- a/types/clipboard/index.d.ts +++ b/types/clipboard/index.d.ts @@ -27,21 +27,21 @@ declare namespace Clipboard { * @param {Element} elem Current element * @returns {String} Only 'cut' or 'copy'. */ - action?: (elem: Element) => string; + action?(elem: Element): string; /** * Overwrites default target input element. * @param {Element} elem Current element * @returns {Element} element to use. */ - target?: (elem: Element) => Element; + target?(elem: Element): Element; /** * Returns the explicit text to copy. * @param {Element} elem Current element * @returns {String} Text to be copied. */ - text?: (elem: Element) => string; + text?(elem: Element): string; } interface Event { diff --git a/types/clndr/clndr-tests.ts b/types/clndr/clndr-tests.ts index 018d9a6000..07bff7f9e4 100644 --- a/types/clndr/clndr-tests.ts +++ b/types/clndr/clndr-tests.ts @@ -89,4 +89,4 @@ myCalendar .setEvents([]) .addEvents([]) .removeEvents(event => event.id === 'idToRemove') - .destroy(); \ No newline at end of file + .destroy(); diff --git a/types/code/code-tests.ts b/types/code/code-tests.ts index c3455577d9..1c2fa78fe5 100644 --- a/types/code/code-tests.ts +++ b/types/code/code-tests.ts @@ -16,7 +16,7 @@ expect([1, 2, 3]).to.part.include([1, 4]); expect(10, "Age").to.be.above(5); -const func = function() { return arguments; }; +const func = function() { return arguments; }; // tslint:disable-line only-arrow-functions expect(func()).to.be.arguments(); expect([1, 2]).to.be.an.array(); diff --git a/types/code/index.d.ts b/types/code/index.d.ts index dacd122915..a17f844d3a 100644 --- a/types/code/index.d.ts +++ b/types/code/index.d.ts @@ -174,7 +174,7 @@ interface Settings { /** * Truncate long assertion error messages for readability? * Defaults to true. - */ + */ truncateMessages?: boolean; /** * Ignore object prototypes when doing a deep comparison? diff --git a/types/codependency/codependency-tests.ts b/types/codependency/codependency-tests.ts index e0f8a793a6..2d39f4be52 100644 --- a/types/codependency/codependency-tests.ts +++ b/types/codependency/codependency-tests.ts @@ -1,8 +1,9 @@ -let requirePeer = codependency.register(module), package: any; - requirePeer = codependency.register(module, {index: ["dependencies", "devDependencies"]}); - requirePeer = codependency.get("some-middleware"); - package = requirePeer("some-peer-dependency-package"); - package = requirePeer("some-peer-dependency-package", {optional: true}); - package = requirePeer("some-peer-dependency-package", {dontThrow: true}); - package = requirePeer("some-peer-dependency-package", {optional: true, dontThrow: true}); - package = requirePeer.resolve("peer-package-name"); \ No newline at end of file +let requirePeer = codependency.register(module); +let package: any; +requirePeer = codependency.register(module, {index: ["dependencies", "devDependencies"]}); +requirePeer = codependency.get("some-middleware"); +package = requirePeer("some-peer-dependency-package"); +package = requirePeer("some-peer-dependency-package", {optional: true}); +package = requirePeer("some-peer-dependency-package", {dontThrow: true}); +package = requirePeer("some-peer-dependency-package", {optional: true, dontThrow: true}); +package = requirePeer.resolve("peer-package-name"); diff --git a/types/codependency/index.d.ts b/types/codependency/index.d.ts index 2ec424588d..c533a52e8e 100644 --- a/types/codependency/index.d.ts +++ b/types/codependency/index.d.ts @@ -22,8 +22,8 @@ interface RequirePeerFunctionOptions { interface RequirePeerFunction { (name: string, options?: RequirePeerFunctionOptions): any; - resolve: (name: string) => DependencyInfo; + resolve(name: string): DependencyInfo; } export function register(baseModule: NodeModule, options?: {index: string[]}): RequirePeerFunction; -export function get(middlewareName: string): RequirePeerFunction; \ No newline at end of file +export function get(middlewareName: string): RequirePeerFunction; diff --git a/types/coinstring/coinstring-tests.ts b/types/coinstring/coinstring-tests.ts index 1cc3fb9a42..556fe1bfc6 100644 --- a/types/coinstring/coinstring-tests.ts +++ b/types/coinstring/coinstring-tests.ts @@ -1,66 +1,62 @@ import cs = require('coinstring'); -var privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; -var privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); -var version = 0x80; // Bitcoin private key +let privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; +let privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); +let version = 0x80; // Bitcoin private key console.log(cs.encode(privateKeyHexBuf, version)); // => 5Hx15HFGyep2CfPxsJKe2fXJsCVn5DEiyoeGGF6JZjGbTRnqfiD -var hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed -var hash160Buf = new Buffer(hash160, 'hex'); -var version = 0x00; // Bitcoin public address +let hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed +let hash160Buf = new Buffer(hash160, 'hex'); +version = 0x00; // Bitcoin public address console.log(cs.encode(hash160Buf, version)); // => 16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS -var privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; +privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; // for compressed, append "01" privateKeyHex += '01'; -var privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); -var version = 0x80; // Bitcoin private key +privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); +version = 0x80; // Bitcoin private key console.log(cs.encode(privateKeyHexBuf, version)); // => KwomKti1X3tYJUUMb1TGSM2mrZk1wb1aHisUNHCQXTZq5auC2qc3 -var hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed -var hash160Buf = new Buffer(hash160, 'hex'); -var version = 0x1E; // Dogecoin public address +hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed +hash160Buf = new Buffer(hash160, 'hex'); +version = 0x1E; // Dogecoin public address console.log(cs.encode(hash160Buf, version)); // => DAcq9oJpZZAjr56RmF7Y5zmWboZWQ4HAsW - -var data = "000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"; -var buffer = new Buffer(data, 'hex'); -var versionBuffer = new Buffer('0488ade4', 'hex'); // 0488ade4 is a consant listed in the aforementioned bip32 wiki. +const data = "000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"; +const buffer = new Buffer(data, 'hex'); +const versionBuffer = new Buffer('0488ade4', 'hex'); // 0488ade4 is a consant listed in the aforementioned bip32 wiki. console.log(cs.encode(buffer, versionBuffer)); // => xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi +privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; +privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); +version = 0x80; // Bitcoin private key -var privateKeyHex = "1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd"; -var privateKeyHexBuf = new Buffer(privateKeyHex, 'hex'); -var version = 0x80; // Bitcoin private key - -var toBtcWif = cs.createEncoder(version); +const toBtcWif = cs.createEncoder(version); // later in your program console.log(toBtcWif(privateKeyHexBuf)); // => 5Hx15HFGyep2CfPxsJKe2fXJsCVn5DEiyoeGGF6JZjGbTRnqfiD +const wif = "5Hx15HFGyep2CfPxsJKe2fXJsCVn5DEiyoeGGF6JZjGbTRnqfiD"; +version = 0x80; // Bitcoin private key -var wif = "5Hx15HFGyep2CfPxsJKe2fXJsCVn5DEiyoeGGF6JZjGbTRnqfiD"; -var version = 0x80; // Bitcoin private key +const fromBtcWif = cs.createDecoder(version); -var fromBtcWif = cs.createDecoder(version); +hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed +hash160Buf = new Buffer(hash160, 'hex'); +version = 0x6F; // Bitcoin Testnet Address - -var hash160 = "3c176e659bea0f29a3e9bf7880c112b1b31b4dc8"; // hash representing uncompressed -var hash160Buf = new Buffer(hash160, 'hex'); -var version = 0x6F; // Bitcoin Testnet Address - -var testnetAddressValidator = cs.createValidator(version); -console.log(testnetAddressValidator("mkzgubTA5Ahi6BPSkE6MN9pEafRutznkMe")); // => true \ No newline at end of file +const testnetAddressValidator = cs.createValidator(version); +console.log(testnetAddressValidator("mkzgubTA5Ahi6BPSkE6MN9pEafRutznkMe")); // => true diff --git a/types/colors/index.d.ts b/types/colors/index.d.ts index e087bd0714..68d6fe593e 100644 --- a/types/colors/index.d.ts +++ b/types/colors/index.d.ts @@ -48,46 +48,46 @@ interface Color { export function setTheme(theme: any): void; -export var enabled: boolean; +export let enabled: boolean; -export var strip: Color; -export var stripColors: Color; +export const strip: Color; +export const stripColors: Color; -export var black: Color; -export var red: Color; -export var green: Color; -export var yellow: Color; -export var blue: Color; -export var magenta: Color; -export var cyan: Color; -export var white: Color; -export var gray: Color; -export var grey: Color; +export const black: Color; +export const red: Color; +export const green: Color; +export const yellow: Color; +export const blue: Color; +export const magenta: Color; +export const cyan: Color; +export const white: Color; +export const gray: Color; +export const grey: Color; -export var bgBlack: Color; -export var bgRed: Color; -export var bgGreen: Color; -export var bgYellow: Color; -export var bgBlue: Color; -export var bgMagenta: Color; -export var bgCyan: Color; -export var bgWhite: Color; +export const bgBlack: Color; +export const bgRed: Color; +export const bgGreen: Color; +export const bgYellow: Color; +export const bgBlue: Color; +export const bgMagenta: Color; +export const bgCyan: Color; +export const bgWhite: Color; -export var reset: Color; -export var bold: Color; -export var dim: Color; -export var italic: Color; -export var underline: Color; -export var inverse: Color; -export var hidden: Color; -export var strikethrough: Color; +export const reset: Color; +export const bold: Color; +export const dim: Color; +export const italic: Color; +export const underline: Color; +export const inverse: Color; +export const hidden: Color; +export const strikethrough: Color; -export var rainbow: Color; -export var zebra: Color; -export var america: Color; -export var trap: Color; -export var random: Color; -export var zalgo: Color; +export const rainbow: Color; +export const zebra: Color; +export const america: Color; +export const trap: Color; +export const random: Color; +export const zalgo: Color; declare global { interface String { @@ -130,4 +130,4 @@ declare global { random: string; zalgo: string; } -} \ No newline at end of file +} diff --git a/types/colors/safe.d.ts b/types/colors/safe.d.ts index c2145b7bc1..306b656b2b 100644 --- a/types/colors/safe.d.ts +++ b/types/colors/safe.d.ts @@ -1,4 +1,4 @@ -export var enabled: boolean; +export const enabled: boolean; export function strip(str: string): string; export function stripColors(str: string): string; diff --git a/types/connect-ensure-login/index.d.ts b/types/connect-ensure-login/index.d.ts index fb1716abf9..bbf827922c 100644 --- a/types/connect-ensure-login/index.d.ts +++ b/types/connect-ensure-login/index.d.ts @@ -23,51 +23,51 @@ interface LoggedOutOptions { } /** -* Ensure that a user is logged in before proceeding to next route middleware. -* -* This middleware ensures that a user is logged in. If a request is received -* that is unauthenticated, the request will be redirected to a login page (by -* default to `/login`). -* -* Additionally, `returnTo` will be be set in the session to the URL of the -* current request. After authentication, this value can be used to redirect -* the user to the page that was originally requested. -* -* Examples: -* -* app.get('/profile', -* ensureLoggedIn(), -* function(req, res) { ... }); -* -* app.get('/profile', -* ensureLoggedIn('/signin'), -* function(req, res) { ... }); -* -* app.get('/profile', -* ensureLoggedIn({ redirectTo: '/session/new', setReturnTo: false }), -* function(req, res) { ... }); -*/ + * Ensure that a user is logged in before proceeding to next route middleware. + * + * This middleware ensures that a user is logged in. If a request is received + * that is unauthenticated, the request will be redirected to a login page (by + * default to `/login`). + * + * Additionally, `returnTo` will be be set in the session to the URL of the + * current request. After authentication, this value can be used to redirect + * the user to the page that was originally requested. + * + * Examples: + * + * app.get('/profile', + * ensureLoggedIn(), + * function(req, res) { ... }); + * + * app.get('/profile', + * ensureLoggedIn('/signin'), + * function(req, res) { ... }); + * + * app.get('/profile', + * ensureLoggedIn({ redirectTo: '/session/new', setReturnTo: false }), + * function(req, res) { ... }); + */ export function ensureLoggedIn(options?: LoggedInOptions | string): RequestHandler; /** -* Ensure that no user is logged in before proceeding to next route middleware. -* -* This middleware ensures that no user is logged in. If a request is received -* that is authenticated, the request will be redirected to another page (by -* default to `/`). -* -* Examples: -* -* app.get('/login', -* ensureLoggedOut(), -* function(req, res) { ... }); -* -* app.get('/login', -* ensureLoggedOut('/home'), -* function(req, res) { ... }); -* -* app.get('/login', -* ensureLoggedOut({ redirectTo: '/home' }), -* function(req, res) { ... }); -*/ + * Ensure that no user is logged in before proceeding to next route middleware. + * + * This middleware ensures that no user is logged in. If a request is received + * that is authenticated, the request will be redirected to another page (by + * default to `/`). + * + * Examples: + * + * app.get('/login', + * ensureLoggedOut(), + * function(req, res) { ... }); + * + * app.get('/login', + * ensureLoggedOut('/home'), + * function(req, res) { ... }); + * + * app.get('/login', + * ensureLoggedOut({ redirectTo: '/home' }), + * function(req, res) { ... }); + */ export function ensureLoggedOut(options?: LoggedOutOptions | string): RequestHandler; diff --git a/types/convert-source-map/convert-source-map-tests.ts b/types/convert-source-map/convert-source-map-tests.ts index 96a638ca93..c591f124c6 100644 --- a/types/convert-source-map/convert-source-map-tests.ts +++ b/types/convert-source-map/convert-source-map-tests.ts @@ -2,11 +2,11 @@ import convert = require("convert-source-map"); // tslint:disable:max-line-length -var json = convert +const json = convert .fromComment('//@ sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9vLmpzIiwic291cmNlcyI6WyJjb25zb2xlLmxvZyhcImhpXCIpOyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSIsInNvdXJjZVJvb3QiOiIvIn0=') .toJSON(); -var modified = convert +const modified = convert .fromComment('//@ sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9vLmpzIiwic291cmNlcyI6WyJjb25zb2xlLmxvZyhcImhpXCIpOyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSIsInNvdXJjZVJvb3QiOiIvIn0=') .setProperty('sources', ['CONSOLE.LOG("HI");']) .toJSON(); diff --git a/types/convert-source-map/index.d.ts b/types/convert-source-map/index.d.ts index e1577c4070..9576e5a08f 100644 --- a/types/convert-source-map/index.d.ts +++ b/types/convert-source-map/index.d.ts @@ -35,7 +35,6 @@ export interface SourceMapConverter { getProperty(key: string): any; } - /** Returns source map converter from given object */ export function fromObject(obj: any): SourceMapConverter; @@ -72,13 +71,13 @@ export function removeComments(src: string): string; export function removeMapFileComments(src: string): string; /** Returns the regex used to find source map comments */ -export var commentRegex: RegExp; +export const commentRegex: RegExp; /** Returns the regex used to find source map comments pointing to map files */ -export var mapFileCommentRegex: RegExp; +export const mapFileCommentRegex: RegExp; /** Returns a comment that links to an external source map via file. * By default, the comment is formatted like: //# sourceMappingURL=..., which you would normally see in a JS source file. * When options.multiline == true, the comment is formatted like: /*# sourceMappingURL=... *\/, which you would find in a CSS source file. */ -export function generateMapFileComment(file: string, options?: { multiline?: boolean }): string; \ No newline at end of file +export function generateMapFileComment(file: string, options?: { multiline?: boolean }): string; diff --git a/types/cookies/cookies-tests.ts b/types/cookies/cookies-tests.ts index 112246907c..c65bcbd4aa 100644 --- a/types/cookies/cookies-tests.ts +++ b/types/cookies/cookies-tests.ts @@ -3,9 +3,9 @@ import * as http from 'http'; const server = http.createServer((req, res) => { const cookies = new Cookies(req, res); - let unsigned: string, - signed: string, - tampered: string; + let unsigned: string; + let signed: string; + let tampered: string; if (req.url === "/set") { cookies diff --git a/types/core-js/index.d.ts b/types/core-js/index.d.ts index dc37560d4d..9593bc7a76 100644 --- a/types/core-js/index.d.ts +++ b/types/core-js/index.d.ts @@ -26,13 +26,13 @@ and limitations under the License. interface SymbolConstructor { /** - * Non-standard. Use simple mode for core-js symbols. See https://github.com/zloirock/core-js/#caveats-when-using-symbol-polyfill - */ + * Non-standard. Use simple mode for core-js symbols. See https://github.com/zloirock/core-js/#caveats-when-using-symbol-polyfill + */ useSimple(): void; /** - * Non-standard. Use setter mode for core-js symbols. See https://github.com/zloirock/core-js/#caveats-when-using-symbol-polyfill - */ + * Non-standard. Use setter mode for core-js symbols. See https://github.com/zloirock/core-js/#caveats-when-using-symbol-polyfill + */ userSetter(): void; } @@ -80,202 +80,202 @@ interface Set { interface ArrayConstructor { /** - * Appends new elements to an array, and returns the new length of the array. - * @param items New elements of the Array. - */ + * Appends new elements to an array, and returns the new length of the array. + * @param items New elements of the Array. + */ push(array: ArrayLike, ...items: T[]): number; /** - * Removes the last element from an array and returns it. - */ + * Removes the last element from an array and returns it. + */ pop(array: ArrayLike): T; /** - * Combines two or more arrays. - * @param items Additional items to add to the end of array1. - */ + * Combines two or more arrays. + * @param items Additional items to add to the end of array1. + */ concat(array: ArrayLike, ...items: Array): T[]; /** - * Adds all the elements of an array separated by the specified separator string. - * @param separator A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. - */ + * Adds all the elements of an array separated by the specified separator string. + * @param separator A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. + */ join(array: ArrayLike, separator?: string): string; /** - * Reverses the elements in an Array. - */ + * Reverses the elements in an Array. + */ reverse(array: ArrayLike): T[]; /** - * Removes the first element from an array and returns it. - */ + * Removes the first element from an array and returns it. + */ shift(array: ArrayLike): T; /** - * Returns a section of an array. - * @param start The beginning of the specified portion of the array. - * @param end The end of the specified portion of the array. - */ + * Returns a section of an array. + * @param start The beginning of the specified portion of the array. + * @param end The end of the specified portion of the array. + */ slice(array: ArrayLike, start?: number, end?: number): T[]; /** - * Sorts an array. - * @param compareFn The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. - */ + * Sorts an array. + * @param compareFn The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. + */ sort(array: ArrayLike, compareFn?: (a: T, b: T) => number): T[]; /** - * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - * @param start The zero-based location in the array from which to start removing elements. - * @param deleteCount The number of elements to remove. - * @param items Elements to insert into the array in place of the deleted elements. - */ + * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. + * @param start The zero-based location in the array from which to start removing elements. + * @param deleteCount The number of elements to remove. + * @param items Elements to insert into the array in place of the deleted elements. + */ splice(array: ArrayLike, start: number, deleteCount?: number, ...items: T[]): T[]; /** - * Inserts new elements at the start of an array. - * @param items Elements to insert at the start of the Array. - */ + * Inserts new elements at the start of an array. + * @param items Elements to insert at the start of the Array. + */ unshift(array: ArrayLike, ...items: T[]): number; /** - * Returns the index of the first occurrence of a value in an array. - * @param searchElement The value to locate in the array. - * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. - */ + * Returns the index of the first occurrence of a value in an array. + * @param searchElement The value to locate in the array. + * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. + */ indexOf(array: ArrayLike, searchElement: T, fromIndex?: number): number; /** - * Returns the index of the last occurrence of a specified value in an array. - * @param searchElement The value to locate in the array. - * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. - */ + * Returns the index of the last occurrence of a specified value in an array. + * @param searchElement The value to locate in the array. + * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. + */ lastIndexOf(array: ArrayLike, earchElement: T, fromIndex?: number): number; /** - * Determines whether all the members of an array satisfy the specified test. - * @param callbackfn A function that accepts up to three arguments. - * The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. - * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. - */ + * Determines whether all the members of an array satisfy the specified test. + * @param callbackfn A function that accepts up to three arguments. + * The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. + * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + */ every(array: ArrayLike, callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean; /** - * Determines whether the specified callback function returns true for any element of an array. - * @param callbackfn A function that accepts up to three arguments. - * The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. - * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. - */ + * Determines whether the specified callback function returns true for any element of an array. + * @param callbackfn A function that accepts up to three arguments. + * The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. + * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + */ some(array: ArrayLike, callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean; /** - * Performs the specified action for each element in an array. - * @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. - * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. - */ + * Performs the specified action for each element in an array. + * @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. + * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + */ forEach(array: ArrayLike, callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void; /** - * Calls a defined callback function on each element of an array, and returns an array that contains the results. - * @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. - * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. - */ + * Calls a defined callback function on each element of an array, and returns an array that contains the results. + * @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. + * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + */ map(array: ArrayLike, callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[]; /** - * Returns the elements of an array that meet the condition specified in a callback function. - * @param callbackfn A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. - * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. - */ + * Returns the elements of an array that meet the condition specified in a callback function. + * @param callbackfn A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. + * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + */ filter(array: ArrayLike, callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): T[]; /** - * Calls the specified callback function for all the elements in an array. - * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. - * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. - * The first call to the callbackfn function provides this value as an argument instead of an array value. - */ + * Calls the specified callback function for all the elements in an array. + * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. + * The first call to the callbackfn function provides this value as an argument instead of an array value. + */ reduce(array: ArrayLike, callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U; /** - * Calls the specified callback function for all the elements in an array. - * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. - * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. - * The first call to the callbackfn function provides this value as an argument instead of an array value. - */ + * Calls the specified callback function for all the elements in an array. + * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. + * The first call to the callbackfn function provides this value as an argument instead of an array value. + */ reduce(array: ArrayLike, callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T; /** - * Calls the specified callback function for all the elements in an array, in descending order. - * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. - * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. - * The first call to the callbackfn function provides this value as an argument instead of an array value. - */ + * Calls the specified callback function for all the elements in an array, in descending order. + * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. + * The first call to the callbackfn function provides this value as an argument instead of an array value. + */ reduceRight(array: ArrayLike, callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U; /** - * Calls the specified callback function for all the elements in an array, in descending order. - * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. - * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. - * The first call to the callbackfn function provides this value as an argument instead of an array value. - */ + * Calls the specified callback function for all the elements in an array, in descending order. + * The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. + * The first call to the callbackfn function provides this value as an argument instead of an array value. + */ reduceRight(array: ArrayLike, callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T; /** - * Returns an array of key, value pairs for every entry in the array - */ + * Returns an array of key, value pairs for every entry in the array + */ entries(array: ArrayLike): IterableIterator<[number, T]>; /** - * Returns an list of keys in the array - */ + * Returns an list of keys in the array + */ keys(array: ArrayLike): IterableIterator; /** - * Returns an list of values in the array - */ + * Returns an list of values in the array + */ values(array: ArrayLike): IterableIterator; /** - * Returns the value of the first element in the array where predicate is true, and undefined - * otherwise. - * @param predicate find calls predicate once for each element of the array, in ascending - * order, until it finds one where predicate returns true. If such an element is found, find - * immediately returns that element value. Otherwise, find returns undefined. - * @param thisArg If provided, it will be used as the this value for each invocation of - * predicate. If it is not provided, undefined is used instead. - */ + * Returns the value of the first element in the array where predicate is true, and undefined + * otherwise. + * @param predicate find calls predicate once for each element of the array, in ascending + * order, until it finds one where predicate returns true. If such an element is found, find + * immediately returns that element value. Otherwise, find returns undefined. + * @param thisArg If provided, it will be used as the this value for each invocation of + * predicate. If it is not provided, undefined is used instead. + */ find(array: ArrayLike, predicate: (value: T, index: number, obj: T[]) => boolean, thisArg?: any): T; /** - * Returns the index of the first element in the array where predicate is true, and undefined - * otherwise. - * @param predicate find calls predicate once for each element of the array, in ascending - * order, until it finds one where predicate returns true. If such an element is found, find - * immediately returns that element value. Otherwise, find returns undefined. - * @param thisArg If provided, it will be used as the this value for each invocation of - * predicate. If it is not provided, undefined is used instead. - */ + * Returns the index of the first element in the array where predicate is true, and undefined + * otherwise. + * @param predicate find calls predicate once for each element of the array, in ascending + * order, until it finds one where predicate returns true. If such an element is found, find + * immediately returns that element value. Otherwise, find returns undefined. + * @param thisArg If provided, it will be used as the this value for each invocation of + * predicate. If it is not provided, undefined is used instead. + */ findIndex(array: ArrayLike, predicate: (value: T) => boolean, thisArg?: any): number; /** - * Returns the this object after filling the section identified by start and end with value - * @param value value to fill array section with - * @param start index to start filling the array at. If start is negative, it is treated as - * length+start where length is the length of the array. - * @param end index to stop filling the array at. If end is negative, it is treated as - * length+end. - */ + * Returns the this object after filling the section identified by start and end with value + * @param value value to fill array section with + * @param start index to start filling the array at. If start is negative, it is treated as + * length+start where length is the length of the array. + * @param end index to stop filling the array at. If end is negative, it is treated as + * length+end. + */ fill(array: ArrayLike, value: T, start?: number, end?: number): T[]; /** - * Returns the this object after copying a section of the array identified by start and end - * to the same array starting at position target - * @param target If target is negative, it is treated as length+target where length is the - * length of the array. - * @param start If start is negative, it is treated as length+start. If end is negative, it - * is treated as length+end. - * @param end If not specified, length of the this object is used as its default value. - */ + * Returns the this object after copying a section of the array identified by start and end + * to the same array starting at position target + * @param target If target is negative, it is treated as length+target where length is the + * length of the array. + * @param start If start is negative, it is treated as length+start. If end is negative, it + * is treated as length+end. + * @param end If not specified, length of the this object is used as its default value. + */ copyWithin(array: ArrayLike, target: number, start: number, end?: number): T[]; includes(array: ArrayLike, value: T, fromIndex?: number): boolean; @@ -290,23 +290,23 @@ interface ArrayConstructor { interface ObjectConstructor { /** - * Non-standard. - */ + * Non-standard. + */ isObject(value: any): boolean; /** - * Non-standard. - */ + * Non-standard. + */ classof(value: any): string; /** - * Non-standard. - */ + * Non-standard. + */ define(target: T, mixin: any): T; /** - * Non-standard. - */ + * Non-standard. + */ make(proto: T, mixin?: any): T; } @@ -322,8 +322,8 @@ interface Log extends Console { } /** - * Non-standard. - */ + * Non-standard. + */ declare var log: Log; // ############################################################################################# @@ -369,8 +369,8 @@ interface DictConstructor { } /** - * Non-standard. - */ + * Non-standard. + */ declare var Dict: DictConstructor; // ############################################################################################# @@ -380,8 +380,8 @@ declare var Dict: DictConstructor; interface Function { /** - * Non-standard. - */ + * Non-standard. + */ part(...args: any[]): any; } @@ -392,13 +392,13 @@ interface Function { interface Date { /** - * Non-standard. - */ + * Non-standard. + */ format(template: string, locale?: string): string; /** - * Non-standard. - */ + * Non-standard. + */ formatUTC(template: string, locale?: string): string; } @@ -409,13 +409,13 @@ interface Date { interface Array { /** - * Non-standard. - */ + * Non-standard. + */ turn(callbackfn: (memo: U, value: T, index: number, array: T[]) => void, memo?: U): U; /** - * Non-standard. - */ + * Non-standard. + */ turn(callbackfn: (memo: T[], value: T, index: number, array: T[]) => void, memo?: T[]): T[]; } @@ -426,8 +426,8 @@ interface Array { interface Number { /** - * Non-standard. - */ + * Non-standard. + */ [Symbol.iterator](): IterableIterator; } @@ -438,13 +438,13 @@ interface Number { interface String { /** - * Non-standard. - */ + * Non-standard. + */ escapeHTML(): string; /** - * Non-standard. - */ + * Non-standard. + */ unescapeHTML(): string; } diff --git a/types/cpy/cpy-tests.ts b/types/cpy/cpy-tests.ts index 047c9943bf..3bc0cbb32a 100644 --- a/types/cpy/cpy-tests.ts +++ b/types/cpy/cpy-tests.ts @@ -4,7 +4,6 @@ cpy(['src/*.png', '!src/goat.png'], 'dist').then(() => { console.log('files copied'); }); - cpy('foo.js', 'destination', { rename: basename => `prefix-${basename}` -}); \ No newline at end of file +}); diff --git a/types/cpy/index.d.ts b/types/cpy/index.d.ts index 039d0b84fb..8ef585250b 100644 --- a/types/cpy/index.d.ts +++ b/types/cpy/index.d.ts @@ -4,4 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped export = cpy; -declare function cpy(src: string | string[], dest: string, opts?: { cwd?: string, parents?: boolean, rename?: (s: string) => string }): Promise; +declare function cpy( + src: string | string[], + dest: string, + opts?: { cwd?: string, parents?: boolean, rename?(s: string): string }): Promise; diff --git a/types/croppie/croppie-tests.ts b/types/croppie/croppie-tests.ts index 92f6d5ca18..26b2449408 100644 --- a/types/croppie/croppie-tests.ts +++ b/types/croppie/croppie-tests.ts @@ -7,7 +7,6 @@ const c = new Croppie(document.getElementById('item'), { enableOrientation: false, }); - c.bind({ url: 'demo/demo-2.jpg', orientation: 4, diff --git a/types/croppie/index.d.ts b/types/croppie/index.d.ts index afd0c0112c..78ab07ad61 100644 --- a/types/croppie/index.d.ts +++ b/types/croppie/index.d.ts @@ -27,7 +27,6 @@ export default class Croppie { destroy(): void; } - export type CropType = 'square' | 'circle'; export type Format = 'jpeg' | 'png' | 'webp'; diff --git a/types/csrf/csrf-tests.ts b/types/csrf/csrf-tests.ts new file mode 100644 index 0000000000..fd3849eb64 --- /dev/null +++ b/types/csrf/csrf-tests.ts @@ -0,0 +1,16 @@ +import Tokens = require('csrf'); + +const csrf = new Tokens(); + +// test synchronous secret/token creation +const secret = csrf.secretSync(); +const token = csrf.create(secret); +csrf.verify(secret, token); + +// test asynchronous secret/token creation +csrf.secret((err: Error, secret: string) => { + if (err) throw err; + + const token = csrf.create(secret); + csrf.verify(secret, token); +}); diff --git a/types/csrf/index.d.ts b/types/csrf/index.d.ts new file mode 100644 index 0000000000..df1e455eb8 --- /dev/null +++ b/types/csrf/index.d.ts @@ -0,0 +1,62 @@ +// Type definitions for b_ 1.3 +// Project: https://github.com/pillarjs/csrf +// Definitions by: Markis Taylor +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +type SecretCallback = (err: Error | null, secret: string) => void; + +interface TokensOptions { + /** + * The string length of the salt (default: 8) + */ + saltLength: number; + /** + * The byte length of the secret key (default: 18) + */ + secretLength: number; +} + +declare class Tokens { + /** + * Token generation/verification class. + * + * @param {object} [options] + * @param {number} [options.saltLength=8] The string length of the salt + * @param {number} [options.secretLength=18] The byte length of the secret key + * @public + */ + constructor(options?: TokensOptions) + + /** + * Create a new CSRF token. + * + * @param {string} secret The secret for the token. + * @public + */ + create(secret: string): string; + + /** + * Create a new secret key. + * + * @param {function} [callback] + * @public + */ + secret(callback?: SecretCallback): Promise; + + /** + * Create a new secret key synchronously. + * @public + */ + secretSync(): string; + + /** + * Verify if a given token is valid for a given secret. + * + * @param {string} secret + * @param {string} token + * @public + */ + verify(secret: string, token: string): boolean; +} + +export = Tokens; diff --git a/types/csrf/tsconfig.json b/types/csrf/tsconfig.json new file mode 100644 index 0000000000..658116154e --- /dev/null +++ b/types/csrf/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "csrf-tests.ts" + ] +} diff --git a/types/csrf/tslint.json b/types/csrf/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/csrf/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } diff --git a/types/csv-stringify/csv-stringify-tests.ts b/types/csv-stringify/csv-stringify-tests.ts index a05f35d368..d7a6f0196b 100644 --- a/types/csv-stringify/csv-stringify-tests.ts +++ b/types/csv-stringify/csv-stringify-tests.ts @@ -12,7 +12,6 @@ stringify([["1", "2", "3"], ["4", "5", "6"]], { // nothing }); - stream = stringify({ delimiter: "," }); stream.write(["1", "2", "3"]); diff --git a/types/csv-stringify/index.d.ts b/types/csv-stringify/index.d.ts index e65695c059..a636547187 100644 --- a/types/csv-stringify/index.d.ts +++ b/types/csv-stringify/index.d.ts @@ -55,7 +55,6 @@ declare namespace stringify { * special values are 'auto', 'unix', 'mac', 'windows', 'unicode'; defaults to 'auto' (discovered in source or 'unix' if no source is specified). */ rowDelimiter?: string; - } interface Stringifier extends NodeJS.ReadWriteStream { diff --git a/types/csvtojson/index.d.ts b/types/csvtojson/index.d.ts index 504311f47a..c0ff659dd3 100644 --- a/types/csvtojson/index.d.ts +++ b/types/csvtojson/index.d.ts @@ -183,7 +183,7 @@ declare namespace csvtojson { * @param {string} str the string to convert * @return {Converter} returns this object for chaining */ - fromString(str: string): this + fromString(str: string): this; /** * Reads in a CSV from a string. @@ -197,7 +197,7 @@ declare namespace csvtojson { * @param {string} filePath the path to the CSV file * @return {Converter} returns this object for chaining */ - fromFile(filePath: string): this + fromFile(filePath: string): this; /** * Reads in a CSV from a file. @@ -211,7 +211,7 @@ declare namespace csvtojson { * @param {Stream} stream the stream * @return {Converter} returns this object for chaining */ - fromStream(stream: NodeJS.ReadableStream): this + fromStream(stream: NodeJS.ReadableStream): this; /** * Reads in a CSV from a stream. diff --git a/types/csvtojson/tslint.json b/types/csvtojson/tslint.json index 377cc837d4..b0e7084e94 100644 --- a/types/csvtojson/tslint.json +++ b/types/csvtojson/tslint.json @@ -1 +1,6 @@ -{ "extends": "../tslint.json" } +{ + "extends": "../tslint.json", + "rules": { + "ban-types": false + } +} diff --git a/types/currency-formatter/currencies.d.ts b/types/currency-formatter/currencies.d.ts index 163bd578de..4d65a9ab53 100644 --- a/types/currency-formatter/currencies.d.ts +++ b/types/currency-formatter/currencies.d.ts @@ -1,2 +1,2 @@ import { currencies } from "./index"; -export = currencies; \ No newline at end of file +export = currencies; diff --git a/types/currency-formatter/currency-formatter-tests.ts b/types/currency-formatter/currency-formatter-tests.ts index a64b9bc48f..f06f53ce05 100644 --- a/types/currency-formatter/currency-formatter-tests.ts +++ b/types/currency-formatter/currency-formatter-tests.ts @@ -42,6 +42,5 @@ currencyFormatter.format(-10, { // => ($10) - import currencies = require('currency-formatter/currencies'); currencies === currencyFormatter.currencies; diff --git a/types/d3-array/index.d.ts b/types/d3-array/index.d.ts index ccd2d568bb..8f5d4eab2e 100644 --- a/types/d3-array/index.d.ts +++ b/types/d3-array/index.d.ts @@ -153,8 +153,8 @@ export function bisectRight(array: Date[], x: Date, lo?: number, hi?: number): n export const bisect: typeof bisectRight; export interface Bisector { - left: (array: T[], x: U, lo?: number, hi?: number) => number; - right: (array: T[], x: U, lo?: number, hi?: number) => number; + left(array: T[], x: U, lo?: number, hi?: number): number; + right(array: T[], x: U, lo?: number, hi?: number): number; } export function bisector(comparator: (a: T, b: U) => number): Bisector; diff --git a/types/d3-axis/index.d.ts b/types/d3-axis/index.d.ts index 4a65952070..9cee537067 100644 --- a/types/d3-axis/index.d.ts +++ b/types/d3-axis/index.d.ts @@ -61,10 +61,10 @@ export interface Axis { (context: Selection): void; /** - * Render the axis to the given context. - * - * @param context A transition defined on SVG containers (either SVG or G elements). - */ + * Render the axis to the given context. + * + * @param context A transition defined on SVG containers (either SVG or G elements). + */ (context: TransitionLike): void; /** @@ -142,10 +142,10 @@ export interface Axis { tickArguments(args: [AxisTimeInterval, string]): this; /** - * Sets the arguments that will be passed to scale.ticks and scale.tickFormat when the axis is rendered, and returns the axis generator. - * - * @param args An array with arguments suitable for the scale to be used for tick generation - */ + * Sets the arguments that will be passed to scale.ticks and scale.tickFormat when the axis is rendered, and returns the axis generator. + * + * @param args An array with arguments suitable for the scale to be used for tick generation + */ tickArguments(args: any[]): this; /** diff --git a/types/d3-drag/d3-drag-tests.ts b/types/d3-drag/d3-drag-tests.ts index deb5a6dc55..4283cb259f 100644 --- a/types/d3-drag/d3-drag-tests.ts +++ b/types/d3-drag/d3-drag-tests.ts @@ -55,7 +55,6 @@ let circleDrag: d3Drag.DragBehavior; - // create new drag behavior ------------------------------------------ circleDrag = d3Drag.drag(); // Use short form method @@ -99,7 +98,6 @@ filterFn = function(d) { // chainable circleDrag = circleDrag.filter(function(d, i, group) { - return (d.color !== 'green' && this.r.baseVal.value < 10) ? !event.button : true; // 'this' is SVGCircleElement and d is CircleDatum }); @@ -192,10 +190,8 @@ const wrongSelection: Selection = select = event; - circleDrag = e.target; // target return drag behavior const type: string = e.type; @@ -224,7 +220,6 @@ handler = e.on('dragged'); // fails, handler with wrong datum type // let wrongHandler4: ((this:SVGCircleElement, d:{test: number}, i: number, group: SVGCircleElement[] | NodeListOf)=> void) | undefined = e.on('dragged'); - // ----------------------------------------------------------------------------- // Test dragDisable() and dragEnable() // ----------------------------------------------------------------------------- diff --git a/types/d3-drag/index.d.ts b/types/d3-drag/index.d.ts index d49e0bbc02..d3a65fb377 100644 --- a/types/d3-drag/index.d.ts +++ b/types/d3-drag/index.d.ts @@ -7,12 +7,10 @@ import { ArrayLike, Selection, ValueFn } from 'd3-selection'; - // -------------------------------------------------------------------------- // Shared Type Definitions and Interfaces // -------------------------------------------------------------------------- - /** * DraggedElementBaseType serves as an alias for the 'minimal' data type which can be selected * without 'd3-drag' (and related code in 'd3-selection') trying to use properties internally which would otherwise not @@ -20,7 +18,6 @@ import { ArrayLike, Selection, ValueFn } from 'd3-selection'; */ export type DraggedElementBaseType = Element; - /** * Container element type usable for mouse/touch functions */ diff --git a/types/d3-dsv/v0/index.d.ts b/types/d3-dsv/v0/index.d.ts index 82ccd0f87f..18701f64ea 100644 --- a/types/d3-dsv/v0/index.d.ts +++ b/types/d3-dsv/v0/index.d.ts @@ -4,11 +4,11 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /** 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.*/ +declare function loader( + /** the symbol used to seperate cells in the row. */ delimiter: string, /** example: "text/plain" */ - encoding?: string) => D3Dsv; + encoding?: string): D3Dsv; export = loader; export as namespace d3_dsv; @@ -16,21 +16,21 @@ export as namespace d3_dsv; /** 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 - - The resulting JavaScript array is: - - [ {"Year": "1997", "Make": "Ford", "Model": "E350", "Length": "2.34"}, - {"Year": "2000", "Make": "Mercury", "Model": "Cougar", "Length": "2.38"} ] - */ + * 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 + * + * The resulting JavaScript array is: + * + * [ {"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. */ @@ -38,42 +38,42 @@ interface D3Dsv { ): 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: - - 1997,Ford,E350,2.34 - 2000,Mercury,Cougar,2.38 - The resulting JavaScript array is: - - [ ["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. - */ + * 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 + * The resulting JavaScript array is: + * + * [ ["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.*/ + /** 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. - */ + * 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; /** - 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. - */ + * 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/types/d3-ease/d3-ease-tests.ts b/types/d3-ease/d3-ease-tests.ts index b50ceba9a4..67a0f32b1b 100644 --- a/types/d3-ease/d3-ease-tests.ts +++ b/types/d3-ease/d3-ease-tests.ts @@ -23,7 +23,6 @@ t_out = d3Ease.easeCubicIn(t_in); t_out = d3Ease.easeCubicOut(t_in); t_out = d3Ease.easeCubicInOut(t_in); - let easePolyFactory: d3Ease.PolynomialEasingFactory; easePolyFactory = d3Ease.easePoly; diff --git a/types/d3-ease/index.d.ts b/types/d3-ease/index.d.ts index 704b55e5e0..3de6fd2e87 100644 --- a/types/d3-ease/index.d.ts +++ b/types/d3-ease/index.d.ts @@ -94,25 +94,24 @@ export interface PolynomialEasingFactory { * Symmetric polynomial easing/easing factory; scales polyIn for t in [0, 0.5] and polyOut for t in [0.5, 1]. * If the exponent is not specified, it defaults to 3, equivalent to cubic. */ -export var easePoly: PolynomialEasingFactory; +export const easePoly: PolynomialEasingFactory; /** * Polynomial easing/easing factory; raises t to the specified exponent. * If the exponent is not specified, it defaults to 3, equivalent to cubicIn. */ -export var easePolyIn: PolynomialEasingFactory; +export const easePolyIn: PolynomialEasingFactory; /** * Reverse polynomial easing/easing factory; equivalent to 1 - polyIn(1 - t). * If the exponent is not specified, it defaults to 3, equivalent to cubicOut. */ -export var easePolyOut: PolynomialEasingFactory; +export const easePolyOut: PolynomialEasingFactory; /** * Symmetric polynomial easing/easing factory; scales polyIn for t in [0, 0.5] and polyOut for t in [0.5, 1]. * If the exponent is not specified, it defaults to 3, equivalent to cubic. */ -export var easePolyInOut: PolynomialEasingFactory; - +export const easePolyInOut: PolynomialEasingFactory; /** * Symmetric sinusoidal easing; scales sinIn for t in [0, 0.5] and sinOut for t in [0.5, 1]. @@ -226,7 +225,6 @@ export function easeBounceOut(normalizedTime: number): number; */ export function easeBounceInOut(normalizedTime: number): number; - /** * Anticipatory easing function factory */ @@ -249,26 +247,25 @@ export interface BackEasingFactory { * Symmetric anticipatory easing; scales backIn for t in [0, 0.5] and backOut for t in [0.5, 1]. * The degree of overshoot is configurable; it not specified, it defaults to 1.70158. */ -export var easeBack: BackEasingFactory; +export const easeBack: BackEasingFactory; /** * Anticipatory easing, like a dancer bending his knees before jumping off the floor. * The degree of overshoot is configurable; it not specified, it defaults to 1.70158. */ -export var easeBackIn: BackEasingFactory; +export const easeBackIn: BackEasingFactory; /** * Reverse anticipatory easing; equivalent to 1 - backIn(1 - t). * The degree of overshoot is configurable; it not specified, it defaults to 1.70158. */ -export var easeBackOut: BackEasingFactory; +export const easeBackOut: BackEasingFactory; /** * Symmetric anticipatory easing; scales backIn for t in [0, 0.5] and backOut for t in [0.5, 1]. * The degree of overshoot is configurable; it not specified, it defaults to 1.70158. */ -export var easeBackInOut: BackEasingFactory; - +export const easeBackInOut: BackEasingFactory; /** * Elastic easing function factory @@ -287,11 +284,11 @@ export interface ElasticEasingFactory { */ amplitude(a: number): ElasticEasingFactory; /** - * Returns a new elastic easing with the specified amplitude a. - * Defaults to 0.3,if not specified. - * - * @param p Period for elastic easing. - */ + * Returns a new elastic easing with the specified amplitude a. + * Defaults to 0.3,if not specified. + * + * @param p Period for elastic easing. + */ period(p: number): ElasticEasingFactory; } @@ -300,25 +297,25 @@ export interface ElasticEasingFactory { * The amplitude and period of the oscillation are configurable; * if not specified, they default to 1 and 0.3, respectively. */ -export var easeElastic: ElasticEasingFactory; +export const easeElastic: ElasticEasingFactory; /** * Elastic easing, like a rubber band. * The amplitude and period of the oscillation are configurable; * if not specified, they default to 1 and 0.3, respectively. */ -export var easeElasticIn: ElasticEasingFactory; +export const easeElasticIn: ElasticEasingFactory; /** * Reverse elastic easing; equivalent to 1 - elasticIn(1 - t). * The amplitude and period of the oscillation are configurable; * if not specified, they default to 1 and 0.3, respectively. */ -export var easeElasticOut: ElasticEasingFactory; +export const easeElasticOut: ElasticEasingFactory; /** * Symmetric elastic easing; scales elasticIn for t in [0, 0.5] and elasticOut for t in [0.5, 1]. * The amplitude and period of the oscillation are configurable; * if not specified, they default to 1 and 0.3, respectively. */ -export var easeElasticInOut: ElasticEasingFactory; +export const easeElasticInOut: ElasticEasingFactory; diff --git a/types/d3-force/d3-force-tests.ts b/types/d3-force/d3-force-tests.ts index 0ecd7555d3..c08e1b5cee 100644 --- a/types/d3-force/d3-force-tests.ts +++ b/types/d3-force/d3-force-tests.ts @@ -6,7 +6,6 @@ * are not intended as functional tests. */ - import * as d3Force from 'd3-force'; // ------------------------------------------------------------------------------------- @@ -30,7 +29,6 @@ interface Graph { links: SimLink[]; } - const graph: Graph = { nodes: [ { id: 'Myriel', group: 1, r: 5 }, @@ -112,7 +110,6 @@ forceCollide = d3Force.forceCollide((node, index, nodes) => { return n.r; }); - // Configure Collision force ----------------------------------------------------------- let radiusAccessor: (node: SimNode, i: number, nodes: SimNode[]) => number; @@ -139,7 +136,6 @@ num = forceCollide.strength(); forceCollide = forceCollide.iterations(10); num = forceCollide.iterations(); - // Use Collision force ----------------------------------------------------------------- forceCollide.initialize(graph.nodes); @@ -157,7 +153,6 @@ forceLink = d3Force.forceLink(); // with link data forceLink = d3Force.forceLink(graph.links); - // Configure Link force ----------------------------------------------------------- let linkNumberAccessor: (link: SimLink, i: number, links: SimLink[]) => number; @@ -181,7 +176,6 @@ num = simLink.value; num = simLink.d; num = simLink.s; - // id (node id accessor) forceLink = forceLink.id((node, index, nodes) => { @@ -220,13 +214,11 @@ linkNumberAccessor = forceLink.strength(); forceLink = forceLink.iterations(10); num = forceLink.iterations(); - // Use Link force ----------------------------------------------------------------- forceLink.initialize(graph.nodes); forceLink(0.1); // alpha - // ManyBody ============================================================================ // create ManyBody force -------------------------------------------------------------- @@ -255,7 +247,6 @@ simNodeNumberAccessor = forceCharge.strength(); forceCharge = forceCharge.theta(0.8); num = forceCharge.theta(); - // distanceMin forceCharge = forceCharge.distanceMin(1); @@ -266,13 +257,11 @@ num = forceCharge.distanceMin(); forceCharge = forceCharge.distanceMax(1000); num = forceCharge.distanceMax(); - // Use ManyBody force ----------------------------------------------------------------- forceCharge.initialize(graph.nodes); forceCharge(0.1); // alpha - // ForceX ============================================================================== // create ForceX force -------------------------------------------------------------- @@ -327,7 +316,6 @@ simNodeNumberAccessor = forcePosX.x(); forcePosX.initialize(graph.nodes); forcePosX(0.1); // alpha - // ForceY ============================================================================== // create ForceY force -------------------------------------------------------------- @@ -388,7 +376,6 @@ forcePosY(0.1); // alpha // Create Force Simulation ============================================================= - let nodeSimulation: d3Force.Simulation; let nodeLinkSimulation: d3Force.Simulation; @@ -435,7 +422,6 @@ num = nodeLinkSimulation.alphaTarget(); nodeLinkSimulation = nodeLinkSimulation.velocityDecay(0.4); num = nodeLinkSimulation.velocityDecay(); - // force() ----------------------------------------------------------------------------- nodeSimulation = nodeSimulation.force('posx', forcePosX); @@ -444,7 +430,6 @@ nodeSimulation.force('posy', forcePosY); // Remove force nodeSimulation = nodeSimulation.force('posx', null); - nodeLinkSimulation = nodeLinkSimulation.force('link', forceLink); nodeLinkSimulation @@ -480,7 +465,6 @@ simLinks = nodeLinkSimulation.force>('link') // fLink = nodeLinkSimulation.force('link')!; // fails, as ForceLink specific properties are missing from 'generic' force - // on() -------------------------------------------------------------------------------- function drawLink(d: SimLink) { @@ -502,7 +486,6 @@ function drawNode(d: SimNode) { } nodeLinkSimulation = nodeLinkSimulation.on('tick', function ticked() { - const that: d3Force.Simulation = this; if (context) { diff --git a/types/d3-force/index.d.ts b/types/d3-force/index.d.ts index 6faa27449a..23f83c7ea3 100644 --- a/types/d3-force/index.d.ts +++ b/types/d3-force/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Tom Wanzek , Alex Ford , Boris Yankov // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - // Last module patch version validated against: 1.0.4 // ----------------------------------------------------------------------- @@ -356,7 +355,6 @@ export interface Force {} } = d3Geo.geoTransform({}); +const transformFunction: { stream(s: d3Geo.GeoStream): {} } = d3Geo.geoTransform({}); interface CustomTranformProto extends d3Geo.GeoTransformPrototype { a: number; @@ -612,7 +612,7 @@ customTransformProto = { a: 10 }; -const t: { stream: (s: d3Geo.GeoStream) => (CustomTranformProto & d3Geo.GeoStream) } = d3Geo.geoTransform(customTransformProto); +const t: { stream(s: d3Geo.GeoStream): CustomTranformProto & d3Geo.GeoStream } = d3Geo.geoTransform(customTransformProto); // geoIdentity() ======================================================== diff --git a/types/d3-geo/index.d.ts b/types/d3-geo/index.d.ts index 1e9fed9b92..f6e4fa150d 100644 --- a/types/d3-geo/index.d.ts +++ b/types/d3-geo/index.d.ts @@ -699,14 +699,14 @@ export interface GeoProjection extends GeoStreamWrapper { */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedFeature): this; /** - * Sets the projection’s scale and translate to fit the specified geographic feature collection in the center of the given extent. - * Returns the projection. - * - * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. - * - * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. - * @param object A geographic feature collection supported by d3-geo (An extension of GeoJSON feature collection). - */ + * Sets the projection’s scale and translate to fit the specified geographic feature collection in the center of the given extent. + * Returns the projection. + * + * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. + * + * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. + * @param object A geographic feature collection supported by d3-geo (An extension of GeoJSON feature collection). + */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedFeatureCollection>): this; /** * Sets the projection’s scale and translate to fit the specified geographic geometry object in the center of the given extent. @@ -719,14 +719,14 @@ export interface GeoProjection extends GeoStreamWrapper { */ fitExtent(extent: [[number, number], [number, number]], object: GeoGeometryObjects): this; /** - * Sets the projection’s scale and translate to fit the specified geographic geometry collection in the center of the given extent. - * Returns the projection. - * - * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. - * - * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. - * @param object A geographic geometry collection supported by d3-geo (An extension of GeoJSON geometry collection). - */ + * Sets the projection’s scale and translate to fit the specified geographic geometry collection in the center of the given extent. + * Returns the projection. + * + * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. + * + * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. + * @param object A geographic geometry collection supported by d3-geo (An extension of GeoJSON geometry collection). + */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedGeometryCollection): this; /** @@ -1340,7 +1340,7 @@ export interface GeoTransformPrototype { * * @param methods An object with custom method implementations, which are used to create a transform projection. */ -export function geoTransform(methods: T): { stream: (s: GeoStream) => (T & GeoStream) }; +export function geoTransform(methods: T): { stream(s: GeoStream): T & GeoStream }; // geoIdentity() ================================================================= @@ -1382,14 +1382,14 @@ export interface GeoIdentityTranform extends GeoStreamWrapper { */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedFeature): this; /** - * Sets the projection’s scale and translate to fit the specified geographic feature collection in the center of the given extent. - * Returns the projection. - * - * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. - * - * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. - * @param object A geographic feature collection supported by d3-geo (An extension of GeoJSON feature collection). - */ + * Sets the projection’s scale and translate to fit the specified geographic feature collection in the center of the given extent. + * Returns the projection. + * + * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. + * + * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. + * @param object A geographic feature collection supported by d3-geo (An extension of GeoJSON feature collection). + */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedFeatureCollection>): this; /** * Sets the projection’s scale and translate to fit the specified geographic geometry object in the center of the given extent. @@ -1402,14 +1402,14 @@ export interface GeoIdentityTranform extends GeoStreamWrapper { */ fitExtent(extent: [[number, number], [number, number]], object: GeoGeometryObjects): this; /** - * Sets the projection’s scale and translate to fit the specified geographic geometry collection in the center of the given extent. - * Returns the projection. - * - * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. - * - * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. - * @param object A geographic geometry collection supported by d3-geo (An extension of GeoJSON geometry collection). - */ + * Sets the projection’s scale and translate to fit the specified geographic geometry collection in the center of the given extent. + * Returns the projection. + * + * Any clip extent is ignored when determining the new scale and translate. The precision used to compute the bounding box of the given object is computed at an effective scale of 150. + * + * @param extent The extent, specified as an array [[x₀, y₀], [x₁, y₁]], where x₀ is the left side of the bounding box, y₀ is the top, x₁ is the right and y₁ is the bottom. + * @param object A geographic geometry collection supported by d3-geo (An extension of GeoJSON geometry collection). + */ fitExtent(extent: [[number, number], [number, number]], object: ExtendedGeometryCollection): this; /** diff --git a/types/d3-scale/d3-scale-tests.ts b/types/d3-scale/d3-scale-tests.ts index c1feb4766a..f317e342ec 100644 --- a/types/d3-scale/d3-scale-tests.ts +++ b/types/d3-scale/d3-scale-tests.ts @@ -92,7 +92,6 @@ linearScaleNumString = linearScaleNumString.domain(domainNumeric); linearScaleNumString = linearScaleNumString.domain(domainNumbers); domainNumbers = linearScaleNumString.domain(); - // range(...) ----------------------------------------------------------------- linearScaleNumber = linearScaleNumber.range(rangeNumbers); @@ -138,7 +137,6 @@ linearScaleNumString = linearScaleNumber.interpolate((a, b) => { // nice(...) ----------------------------------------------------------------------- - // chainable linearScaleNumber = linearScaleNumber.nice(); linearScaleNumber = linearScaleNumber.nice(5); @@ -180,7 +178,6 @@ powerScaleNumber = d3Scale.scalePow(); powerScaleString = d3Scale.scalePow(); powerScaleNumString = d3Scale.scalePow(); - let squarerootScaleNumber: d3Scale.ScalePower; let squarerootScaleString: d3Scale.ScalePower; let squarerootScaleNumString: d3Scale.ScalePower; @@ -211,7 +208,6 @@ powerScaleNumString = powerScaleNumString.domain(domainNumeric); powerScaleNumString = powerScaleNumString.domain(domainNumbers); domainNumbers = powerScaleNumString.domain(); - // range(...) ----------------------------------------------------------------- powerScaleNumber = powerScaleNumber.range(rangeNumbers); @@ -282,7 +278,6 @@ const copiedPowerScale: d3Scale.ScalePower = powerScaleNumString // Logarithmic Scale Factory // ------------------------------------------------------------------------------- - // scaleLog() --------------------------------------------------------------------- let logScaleNumber: d3Scale.ScaleLogarithmic; @@ -293,7 +288,6 @@ logScaleNumber = d3Scale.scaleLog(); logScaleString = d3Scale.scaleLog(); logScaleNumString = d3Scale.scaleLog(); - // ScaleLogarithmic Interface ======================================================== // base -------------------------------------------------------------------- @@ -316,7 +310,6 @@ logScaleNumString = logScaleNumString.domain(domainNumeric); logScaleNumString = logScaleNumString.domain(domainNumbers); domainNumbers = logScaleNumString.domain(); - // range(...) ----------------------------------------------------------------- logScaleNumber = logScaleNumber.range(rangeNumbers); @@ -393,10 +386,8 @@ let identityScale: d3Scale.ScaleIdentity; identityScale = d3Scale.scaleIdentity(); - // ScaleIdentity Interface ======================================================== - // domain(...) ----------------------------------------------------------------- identityScale = identityScale.domain(domainNumeric); @@ -434,12 +425,10 @@ tickFormatNumberFn = identityScale.tickFormat(5, '+%'); outputNumber = identityScale(10); - // copy(...) ----------------------------------------------------------------- const copiedIdentityScale: d3Scale.ScaleIdentity = identityScale.copy(); - // ------------------------------------------------------------------------------- // Time Scale Factories // ------------------------------------------------------------------------------- @@ -454,7 +443,6 @@ localTimeScaleNumber = d3Scale.scaleTime(); localTimeScaleString = d3Scale.scaleTime(); localTimeScaleNumString = d3Scale.scaleTime(); - let utcScaleNumber: d3Scale.ScaleTime; let utcScaleString: d3Scale.ScaleTime; let utcScaleNumString: d3Scale.ScaleTime; @@ -475,7 +463,6 @@ domainDates = localTimeScaleString.domain(); localTimeScaleNumString = localTimeScaleNumString.domain(domainDates); domainDates = localTimeScaleNumString.domain(); - // range(...) ----------------------------------------------------------------- localTimeScaleNumber = localTimeScaleNumber.range(rangeNumbers); @@ -534,7 +521,6 @@ if (timeInterval !== null) { ticksDates = localTimeScaleNumString.ticks(timeInterval); } - // tickFormat(...) ----------------------------------------------------------------- tickFormatDateFn = localTimeScaleNumber.tickFormat(); @@ -543,7 +529,6 @@ if (timeInterval !== null) { tickFormatDateFn = localTimeScaleNumber.tickFormat(timeInterval, '%I %p'); } - // (...) value mapping from domain to output ----------------------------------- outputNumber = localTimeScaleNumber(new Date(2016, 6, 4)); @@ -595,8 +580,6 @@ outputString = sequentialScaleColorString(10); const copiedSequentialScale: d3Scale.ScaleSequential = sequentialScaleColorString.copy(); - - // ------------------------------------------------------------------------------- // Color Interpolators for Sequential Scale Factory // ------------------------------------------------------------------------------- @@ -619,7 +602,6 @@ colorInterpolator = d3Scale.interpolateCool; colorInterpolator = d3Scale.interpolateCubehelixDefault; - // ------------------------------------------------------------------------------- // Quantize Scale Factory // ------------------------------------------------------------------------------- @@ -632,7 +614,6 @@ let quantizeScaleString: d3Scale.ScaleQuantize; quantizeScaleNumber = d3Scale.scaleQuantize(); quantizeScaleString = d3Scale.scaleQuantize(); - // ScaleQuantize Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -649,7 +630,6 @@ rangeNumbers = quantizeScaleNumber.range(); quantizeScaleString = quantizeScaleString.range(['steelblue', 'brown']); rangeStrings = quantizeScaleString.range(); - // invertExtent(...) ----------------------------------------------------------------- numExtent = quantizeScaleNumber.invertExtent(500); @@ -681,12 +661,10 @@ outputNumber = quantizeScaleNumber(0.51); const copiedQuantizeScale: d3Scale.ScaleQuantize = quantizeScaleNumber.copy(); - // ------------------------------------------------------------------------------- // Quantile Scale Factory // ------------------------------------------------------------------------------- - // scaleQuantile() ----------------------------------------------------------------- let quantileScaleNumber: d3Scale.ScaleQuantile; @@ -695,7 +673,6 @@ let quantileScaleString: d3Scale.ScaleQuantile; quantileScaleNumber = d3Scale.scaleQuantile(); quantileScaleString = d3Scale.scaleQuantile(); - // ScaleQuantile Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -714,7 +691,6 @@ rangeNumbers = quantileScaleNumber.range(); quantileScaleString = quantileScaleString.range(['q25', 'q50', 'q75']); rangeStrings = quantileScaleString.range(); - // invertExtent(...) ----------------------------------------------------------------- numExtent = quantileScaleNumber.invertExtent(2); @@ -733,7 +709,6 @@ outputNumber = quantileScaleNumber(0.51); const copiedQuantileScale: d3Scale.ScaleQuantile = quantileScaleNumber.copy(); - // ------------------------------------------------------------------------------- // Threshold Scale Factory // ------------------------------------------------------------------------------- @@ -746,7 +721,6 @@ let thresholdScaleNumberString: d3Scale.ScaleThreshold; thresholdScaleNumberNumber = d3Scale.scaleThreshold(); thresholdScaleNumberString = d3Scale.scaleThreshold(); - // ScaleThreshold Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -764,7 +738,6 @@ rangeNumbers = thresholdScaleNumberNumber.range(); thresholdScaleNumberString = thresholdScaleNumberString.range(['steelblue', 'seagreen', 'brown']); rangeStrings = thresholdScaleNumberString.range(); - // invertExtent(...) ----------------------------------------------------------------- numOrUndefinedExtent = thresholdScaleNumberNumber.invertExtent(100); @@ -781,7 +754,6 @@ outputString = thresholdScaleNumberString(0.9); const copiedThresholdScale: d3Scale.ScaleThreshold = thresholdScaleNumberString.copy(); - // ------------------------------------------------------------------------------- // Ordinal Scale Factory // ------------------------------------------------------------------------------- @@ -794,7 +766,6 @@ let ordinalScaleStringNumber: d3Scale.ScaleOrdinal; ordinalScaleStringString = d3Scale.scaleOrdinal(); ordinalScaleStringNumber = d3Scale.scaleOrdinal(); - // ScaleOrdinal Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -812,7 +783,6 @@ rangeStrings = ordinalScaleStringString.range(); ordinalScaleStringNumber = ordinalScaleStringNumber.range([-1, 0, 1]); rangeNumbers = ordinalScaleStringNumber.range(); - // unknown(...) and d3Scale.scaleImplicit -------------------------------------- const implicit: { name: 'implicit' } = d3Scale.scaleImplicit; @@ -839,7 +809,6 @@ outputNumber = ordinalScaleStringNumber('negative'); const copiedOrdinalScale: d3Scale.ScaleOrdinal = ordinalScaleStringNumber.copy(); - // ------------------------------------------------------------------------------- // Band Scale Factory // ------------------------------------------------------------------------------- @@ -852,7 +821,6 @@ let bandScaleCoercible: d3Scale.ScaleBand; bandScaleString = d3Scale.scaleBand(); bandScaleCoercible = d3Scale.scaleBand(); - // ScaleBand Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -870,12 +838,10 @@ let rangeExtent: [number, number] = bandScaleString.range(); bandScaleCoercible = bandScaleCoercible.range([0, 300]); rangeExtent = bandScaleCoercible.range(); - // rangeRound(...) ----------------------------------------------------------------- bandScaleString = bandScaleString.rangeRound([0, 300]); - // round(...) ----------------------------------------------------------------- bandScaleCoercible = bandScaleCoercible.round(true); @@ -891,7 +857,6 @@ num = bandScaleString.paddingInner(); bandScaleString = bandScaleString.paddingOuter(0.1); num = bandScaleString.paddingOuter(); - // padding(...) ----------------------------------------------------------------- bandScaleString = bandScaleString.padding(0.1); @@ -910,7 +875,6 @@ num = bandScaleString.bandwidth(); num = bandScaleString.step(); - // (...) value mapping from domain to output ----------------------------------- outputNumberMaybe = bandScaleString('neutral'); @@ -921,7 +885,6 @@ outputNumberMaybe = bandScaleCoercible(new StringCoercible('negative')); const copiedBandScale: d3Scale.ScaleBand = bandScaleCoercible.copy(); - // ------------------------------------------------------------------------------- // Point Scale Factory // ------------------------------------------------------------------------------- @@ -934,7 +897,6 @@ let pointScaleCoercible: d3Scale.ScalePoint; pointScaleString = d3Scale.scalePoint(); pointScaleCoercible = d3Scale.scalePoint(); - // ScalePoint Interface ======================================================== // domain(...) ----------------------------------------------------------------- @@ -952,18 +914,15 @@ rangeExtent = pointScaleString.range(); pointScaleCoercible = pointScaleCoercible.range([0, 300]); rangeExtent = pointScaleCoercible.range(); - // rangeRound(...) ----------------------------------------------------------------- pointScaleString = pointScaleString.rangeRound([0, 300]); - // round(...) ----------------------------------------------------------------- pointScaleCoercible = pointScaleCoercible.round(true); roundingFlag = pointScaleCoercible.round(); - // padding(...) ----------------------------------------------------------------- pointScaleString = pointScaleString.padding(0.1); diff --git a/types/d3-scale/index.d.ts b/types/d3-scale/index.d.ts index 2ba9eeec8a..8a114d90e1 100644 --- a/types/d3-scale/index.d.ts +++ b/types/d3-scale/index.d.ts @@ -33,16 +33,15 @@ export interface InterpolatorFactory { * A helper interface for a continuous scale defined over a numeric domain. */ export interface ScaleContinuousNumeric { - /** - * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. - * - * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. - * - * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. - * - * @param value A numeric value from the domain. - */ + * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. + * + * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. + * + * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. + * + * @param value A numeric value from the domain. + */ (value: number | { valueOf(): number }): Output; /** @@ -163,7 +162,6 @@ export interface ScaleContinuousNumeric { * Returns an exact copy of this scale. Changes to this scale will not affect the returned scale, and vice versa. */ copy(): this; - } // ------------------------------------------------------------------------------- @@ -188,7 +186,6 @@ export interface ScaleContinuousNumeric { * convert the interpolated range element to a corresponding output element. */ export interface ScaleLinear extends ScaleContinuousNumeric { - /** * Returns the scale’s current interpolator factory, which defaults to interpolate. */ @@ -222,7 +219,6 @@ export interface ScaleLinear extends ScaleContinuousNumeric(interpolate: InterpolatorFactory): ScaleLinear; - } /** @@ -281,7 +277,6 @@ export function scaleLinear(): ScaleLinear; * convert the interpolated range element to a corresponding output element. */ export interface ScalePower extends ScaleContinuousNumeric { - /** * Returns the scale’s current interpolator factory, which defaults to interpolate. */ @@ -428,7 +423,6 @@ export function scaleSqrt(): ScalePower; * convert the interpolated range element to a corresponding output element. */ export interface ScaleLogarithmic extends ScaleContinuousNumeric { - /** * Returns a copy of the scale’s current domain. */ @@ -578,16 +572,15 @@ export function scaleLog(): ScaleLogarithmic; * These scales are occasionally useful when working with pixel coordinates, say in conjunction with an axis or brush. */ export interface ScaleIdentity { - /** - * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. - * - * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. - * - * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. - * - * @param value A numeric value from the domain. - */ + * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. + * + * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. + * + * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. + * + * @param value A numeric value from the domain. + */ (value: number | { valueOf(): number }): number; /** @@ -688,7 +681,6 @@ export interface ScaleIdentity { */ export function scaleIdentity(): ScaleIdentity; - // ------------------------------------------------------------------------------- // Time Scale Factories // ------------------------------------------------------------------------------- @@ -710,16 +702,15 @@ export function scaleIdentity(): ScaleIdentity; * convert the interpolated range element to a corresponding output element. */ export interface ScaleTime { - /** - * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. - * - * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. - * - * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. - * - * @param value A temporal value from the domain. If the value is not a Date, it will be coerced to Date. - */ + * Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any. + * + * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. + * + * Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation. + * + * @param value A temporal value from the domain. If the value is not a Date, it will be coerced to Date. + */ (value: Date | number | { valueOf(): number }): Output; /** @@ -1022,14 +1013,13 @@ export function scaleUtc(): ScaleTime; * The generic corresponds to the data type of the output of the interpolator underlying the scale. */ export interface ScaleSequential { - /** - * Given a value from the domain, returns the corresponding value from the output range, subject to interpolation. - * - * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. - * - * @param value A numeric value from the domain. - */ + * Given a value from the domain, returns the corresponding value from the output range, subject to interpolation. + * + * If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range. + * + * @param value A numeric value from the domain. + */ (value: number | { valueOf(): number }): Output; /** @@ -1209,7 +1199,7 @@ export interface ScaleQuantize { */ range(range: Range[]): this; - /** + /** * Returns approximately count representative values from the scale’s domain. * * If count is not specified, it defaults to 10. @@ -1282,7 +1272,6 @@ export function scaleQuantize(): ScaleQuantize; * The generic correponds to the data type of range elements. */ export interface ScaleQuantile { - /** * Given a value in the input domain, returns the corresponding value in the output range. * @@ -1542,7 +1531,6 @@ export function scaleOrdinal(range */ export const scaleImplicit: { name: 'implicit' }; - // ------------------------------------------------------------------------------- // Band Scale Factory // ------------------------------------------------------------------------------- @@ -1828,7 +1816,6 @@ export function scalePoint(): ScalePoint; */ export function scalePoint(): ScalePoint; - // ------------------------------------------------------------------------------- // Categorical Color Schemas for Ordinal Scales // ------------------------------------------------------------------------------- diff --git a/types/d3-selection/index.d.ts b/types/d3-selection/index.d.ts index b007573b1f..34196f755e 100644 --- a/types/d3-selection/index.d.ts +++ b/types/d3-selection/index.d.ts @@ -552,17 +552,17 @@ interface Selection; /** - * Filters the selection, returning a new selection that contains only the elements for - * which the specified filter is true. - * - * The returned filtered selection preserves the parents of this selection, but like array.filter, - * it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed. - * - * The generic refers to the type of element which will be selected after applying the filter, i.e. if the element types - * contained in a pre-filter selection are narrowed to a subset as part of the filtering. - * - * @param selector A CSS selector string to match when filtering. - */ + * Filters the selection, returning a new selection that contains only the elements for + * which the specified filter is true. + * + * The returned filtered selection preserves the parents of this selection, but like array.filter, + * it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed. + * + * The generic refers to the type of element which will be selected after applying the filter, i.e. if the element types + * contained in a pre-filter selection are narrowed to a subset as part of the filtering. + * + * @param selector A CSS selector string to match when filtering. + */ filter(selector: string): Selection; /** * Filter the selection, returning a new selection that contains only the elements for diff --git a/types/d3-shape/index.d.ts b/types/d3-shape/index.d.ts index e1d80b6786..517f84e501 100644 --- a/types/d3-shape/index.d.ts +++ b/types/d3-shape/index.d.ts @@ -1990,14 +1990,14 @@ export interface Symbol { /** * Constructs a new symbol generator with the default settings. */ -export function symbol(): Symbol; +export function symbol(): Symbol; // tslint:disable-line ban-types /** * Constructs a new symbol generator with the default settings. * * The generic corrsponds to the data type of the datum underlying the symbol. */ -export function symbol(): Symbol; +export function symbol(): Symbol; // tslint:disable-line ban-types /** * Constructs a new symbol generator with the default settings. @@ -2005,7 +2005,7 @@ export function symbol(): Symbol; * The first generic corresponds to the "this" context within which the symbol generator is invoked. * The second generic corrsponds to the data type of the datum underlying the symbol. */ -export function symbol(): Symbol; +export function symbol(): Symbol; // tslint:disable-line ban-types /** * An array containing the set of all built-in symbol types: circle, cross, diamond, square, star, triangle, and wye. diff --git a/types/daterangepicker/daterangepicker-tests.ts b/types/daterangepicker/daterangepicker-tests.ts index 04ff80c0e8..dc305bf1da 100644 --- a/types/daterangepicker/daterangepicker-tests.ts +++ b/types/daterangepicker/daterangepicker-tests.ts @@ -1,4 +1,5 @@ import moment = require("moment") +import daterangepicker = require("daterangepicker"); function tests_simple() { $('#daterange').daterangepicker(); @@ -65,5 +66,15 @@ function tests_simple() { showCustomRangeLabel: false }, cb); + $('#endDate').daterangepicker({ + singleDatePicker: true, + startDate: moment() + }); }); } + +declare const host: HTMLElement; +function test_from_amd() { + var picker = new daterangepicker(host); + console.log(picker.startDate.format("YYYY-MM-DD")); +} diff --git a/types/daterangepicker/index.d.ts b/types/daterangepicker/index.d.ts index d78e06dd97..600e8b3d5f 100644 --- a/types/daterangepicker/index.d.ts +++ b/types/daterangepicker/index.d.ts @@ -9,11 +9,21 @@ import moment = require("moment"); declare global { interface JQuery { daterangepicker(settings?: daterangepicker.Settings): JQuery; - daterangepicker(settings?: daterangepicker.Settings, callback?: (start?: string | Date | moment.Moment, end?: string | Date | moment.Moment, label?: string) => any): JQuery; + daterangepicker(settings?: daterangepicker.Settings, callback?: daterangepicker.DataRangePickerCallback): JQuery; } } +declare const daterangepicker: daterangepicker.DateRangePicker; + declare namespace daterangepicker { + type DataRangePickerCallback = (start?: string | Date | moment.Moment, end?: string | Date | moment.Moment, label?: string) => any; + + interface DateRangePicker { + new (element: HTMLElement, settings?: daterangepicker.Settings, callback?: DataRangePickerCallback): DateRangePicker; + + startDate: moment.Moment; + endDate: moment.Moment; + } interface DatepickerEventObject extends JQueryEventObject { date: Date; diff --git a/types/decay/decay-tests.ts b/types/decay/decay-tests.ts index 41b67b6068..20f33210ac 100644 --- a/types/decay/decay-tests.ts +++ b/types/decay/decay-tests.ts @@ -19,4 +19,4 @@ score = hackerCalculator(upvotes, posted); let wilsonCalculator = wilsonScore(); score = wilsonCalculator(upvotes, downvotes); wilsonCalculator = wilsonScore(1.0); -score = wilsonCalculator(upvotes, downvotes); \ No newline at end of file +score = wilsonCalculator(upvotes, downvotes); diff --git a/types/deepmerge/deepmerge-tests.ts b/types/deepmerge/deepmerge-tests.ts index 4106de1275..8c7988ba78 100644 --- a/types/deepmerge/deepmerge-tests.ts +++ b/types/deepmerge/deepmerge-tests.ts @@ -10,4 +10,4 @@ const expected = { foo: { bar: 3, baz: 4 }, array: [ { does: 'work', too: [ 1, 2, 3, 4, 5, 6 ] }, { really: 'yes' } ], quux: 5 }; -const result = deepmerge(x, y); \ No newline at end of file +const result = deepmerge(x, y); diff --git a/types/deepmerge/index.d.ts b/types/deepmerge/index.d.ts index bf70f62e46..96d0412aa6 100644 --- a/types/deepmerge/index.d.ts +++ b/types/deepmerge/index.d.ts @@ -10,8 +10,8 @@ declare function deepmerge(x: T, y: T, options?: deepmerge.Options): T; declare namespace deepmerge { interface Options { clone?: boolean; - arrayMerge?: (destination: T, source: T, options?: Options) => T; + arrayMerge?(destination: T, source: T, options?: Options): T; } function all(objects: T[], options?: Options): T; -} \ No newline at end of file +} diff --git a/types/del/del-tests.ts b/types/del/del-tests.ts index 071fdcc3ad..09702c4b39 100644 --- a/types/del/del-tests.ts +++ b/types/del/del-tests.ts @@ -1,6 +1,6 @@ import del = require("del"); -var paths = ["build", "dist/**/*.js"]; +let paths = ["build", "dist/**/*.js"]; del(["tmp/*.js", "!tmp/unicorn.js"]); @@ -26,7 +26,6 @@ del("tmp/*.js", {force: true}).then((paths: string[]) => { console.log('Deleted files/folders:\n', paths.join('\n')); }); -var paths: string[]; paths = del.sync(["tmp/*.js", "!tmp/unicorn.js"]); paths = del.sync(["tmp/*.js", "!tmp/unicorn.js"], {force: true}); diff --git a/types/detect-port/detect-port-tests.ts b/types/detect-port/detect-port-tests.ts index 5ffd01ca7c..759313665b 100644 --- a/types/detect-port/detect-port-tests.ts +++ b/types/detect-port/detect-port-tests.ts @@ -8,10 +8,9 @@ const port: number = 8000; detect(port, (err: Error, _port: number) => { }); - function* yieldSyntax() { const _port: number = yield detect(port); -}; +} /** * use as a promise diff --git a/types/discontinuous-range/discontinuous-range-tests.ts b/types/discontinuous-range/discontinuous-range-tests.ts index 8b31d11b11..cfc69ed371 100644 --- a/types/discontinuous-range/discontinuous-range-tests.ts +++ b/types/discontinuous-range/discontinuous-range-tests.ts @@ -21,4 +21,4 @@ const entry: number | null = rangeOne.index(1); const stringified: string = rangeOne.toString(); // clone -const rangeThree: DiscontinuousRange = rangeOne.clone(); \ No newline at end of file +const rangeThree: DiscontinuousRange = rangeOne.clone(); diff --git a/types/discontinuous-range/index.d.ts b/types/discontinuous-range/index.d.ts index 670379a57e..edb6a1efd6 100644 --- a/types/discontinuous-range/index.d.ts +++ b/types/discontinuous-range/index.d.ts @@ -7,7 +7,6 @@ * Represents a discontinuous range of numbers. */ declare class DiscontinuousRange { - /** * Creates a discontinuous range at rangeStart, and ending at * rangeEnd. If rangeEnd is not specified, a range containing @@ -70,4 +69,4 @@ declare class DiscontinuousRange { clone(): DiscontinuousRange; } -export = DiscontinuousRange; \ No newline at end of file +export = DiscontinuousRange; diff --git a/types/dockerode/dockerode-tests.ts b/types/dockerode/dockerode-tests.ts index 3bd1c30097..4b4e406839 100644 --- a/types/dockerode/dockerode-tests.ts +++ b/types/dockerode/dockerode-tests.ts @@ -55,4 +55,70 @@ docker.createContainer({ Tty: true }, (err, container) => { container.start((err, data) => { // NOOP }); -}); \ No newline at end of file +}); + +docker.pruneContainers((err, response) => { + // NOOP +}); + +docker.pruneImages((err, response) => { + // NOOP +}); + +docker.pruneNetworks((err, response) => { + // NOOP +}); + +docker.pruneVolumes((err, response) => { + // NOOP +}); + +const plugin = docker.getPlugin('pluginName', 'remoteName'); +plugin.configure((err, response) => { + // NOOP; +}); + +plugin.disable((err, response) => { + // NOOP +}); + +plugin.enable((err, response) => { + // NOOP +}); + +plugin.inspect((err, response) => { + // NOOP +}); + +plugin.privileges((err, response) => { + // NOOP +}); + +plugin.pull({}, (err, response) => { + // NOOP +}); + +plugin.push((err, response) => { + // NOOP +}); + +plugin.remove((err, response) => { + // NOOP +}); + +plugin.upgrade({}, (err, response) => { + // NOOP +}); + +const secret = docker.getSecret('secretName'); +secret.inspect((err, response) => { + // NOOP +}); + +secret.remove((err, response) => { + // NOOP +}); + +secret.update((err, response) => { + // NOOP +}); diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 968199436a..2e834f0b3b 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for dockerode 2.3 +// Type definitions for dockerode 2.4 // Project: https://github.com/apocas/dockerode -// Definitions by: Carl Winkler +// Definitions by: Carl Winkler , Nicolas Laplante // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -8,7 +8,6 @@ import * as stream from 'stream'; import * as events from 'events'; - declare namespace Dockerode { interface Container { inspect(options: {}, callback: Callback): void; @@ -94,8 +93,8 @@ declare namespace Dockerode { tag(options: {}, callback: Callback): void; tag(callback: Callback): void; - remove(options: {}, callback: Callback): void; - remove(callback: Callback): void; + remove(options: {}, callback: Callback): void; + remove(callback: Callback): void; modem: any; id?: string; @@ -137,6 +136,49 @@ declare namespace Dockerode { id?: string; } + interface Plugin { + modem: any; + name: string; + remote: any; + + inspect(callback: Callback): void; + + remove(options: {}, callback: Callback): void; + remove(callback: Callback): void; + + privileges(callback: Callback): void; + + pull(options: {}, callback: Callback): void; + + enable(options: {}, callback: Callback): void; + enable(callback: Callback): void; + + disable(options: {}, callback: Callback): void; + disable(callback: Callback): void; + + push(options: {}, callback: Callback): void; + push(callback: Callback): void; + + configure(options: {}, callback: Callback): void; + configure(callback: Callback): void; + + upgrade(auth: any, options: {}, callback: Callback): void; + upgrade(auth: any, callback: Callback): void; + } + + interface Secret { + inspect(callback: Callback): void; + + update(options: {}, callback: Callback): void; + update(callback: Callback): void; + + remove(options: {}, callback: Callback): void; + remove(callback: Callback): void; + + modem: any; + id?: string; + } + interface Network { inspect(callback: Callback): void; @@ -546,6 +588,137 @@ declare namespace Dockerode { protocol?: "https" | "http"; timeout?: number; } + + interface SecretVersion { + Index: number; + } + + interface ServiceSpec { + Name: string; + } + + interface SecretInfo { + ID: string; + Version: SecretVersion; + CreatedAt: string; + UpdatedAt?: string; + Spec?: ServiceSpec; + } + + interface PluginInfo { + Id?: string; + Name: string; + Enabled: boolean; + Settings: PluginSettings; + PluginReference?: string; + Config: PluginConfig; + } + + type PluginInspectInfo = PluginInfo; + + interface PluginSettings { + Mounts: PluginMount[]; + Env: string[]; + Args: string[]; + Devices: PluginDevice[]; + } + + interface PluginConfig { + Description: string; + Documentation: string; + Interface: any; + Entrypoint: string[]; + WorkDir: string; + User?: User; + Network: Network; + Linux: Linux; + PropagatedMount: string; + Mounts: PluginMount[]; + Env: PluginEnv[]; + Args: Args; + rootfs: any; + } + + interface Interface { + Types: PluginInterfaceType[]; + Socket: string; + } + + interface PluginInterfaceType { + Prefix: string; + Capability: string; + Version: string; + } + + interface PluginMount { + Name: string; + Description: string; + Settable: string[]; + Source: string; + Destination: string; + Type: string; + Options: string[]; + } + + interface Linux { + Capabilities: string[]; + AllowAllDevices: boolean; + Devices: PluginDevice[]; + } + + interface PluginDevice { + Name: string; + Description: string; + Settable: string[]; + Path: string; + } + + interface Network { + Type: string; + } + + interface PluginEnv { + Name: string; + Description: string; + Settable: string[]; + Value: string; + } + + interface Args { + Name: string; + Description: string; + Settable: string[]; + Value: string; + } + + interface User { + UID: number; + GID: number; + } + + interface ImageRemoveInfo { + Untagged: string; + Deleted: string; + } + + interface PruneImagesInfo { + ImagesDeleted: ImageRemoveInfo[]; + SpaceReclaimed: number; + } + + interface PruneVolumesInfo { + VolumesDeleted: string[]; + SpaceReclaimed: number; + } + + interface PruneContainersInfo { + ContainersDeleted: string[]; + SpaceReclaimed: number; + } + + interface PruneNetworksInfo { + NetworksDeleted: string[]; + } } type Callback = (error?: any, result?: T) => void; @@ -575,6 +748,8 @@ declare class Dockerode { getVolume(name: string): Dockerode.Volume; + getPlugin(name: string, remote: any): Dockerode.Plugin; + getService(id: string): Dockerode.Service; getTask(id: string): Dockerode.Task; @@ -583,6 +758,8 @@ declare class Dockerode { getNetwork(id: string): Dockerode.Network; + getSecret(id: string): Dockerode.Secret; + getExec(id: string): Dockerode.Exec; listContainers(options: {}, callback: Callback): void; @@ -600,12 +777,22 @@ declare class Dockerode { listTasks(options: {}, callback: Callback): void; listTasks(callback: Callback): void; + listSecrets(options: {}, callback: Callback): void; + listSecrets(callback: Callback): void; + + listPlugins(options: {}, callback: Callback): void; + listPlugins(callback: Callback): void; + listVolumes(options: {}, callback: Callback): void; listVolumes(callback: Callback): void; listNetworks(options: {}, callback: Callback): void; listNetworks(callback: Callback): void; + createSecret(options: {}, callback: Callback): void; + + createPlugin(options: {}, callback: Callback): void; + createVolume(options: {}, callback: Callback): void; createService(options: {}, callback: Callback): void; @@ -614,6 +801,18 @@ declare class Dockerode { searchImages(options: {}, callback: Callback): void; + pruneImages(options: {}, callback: Callback): void; + pruneImages(callback: Callback): void; + + pruneContainers(options: {}, callback: Callback): void; + pruneContainers(callback: Callback): void; + + pruneVolumes(options: {}, callback: Callback): void; + pruneVolumes(callback: Callback): void; + + pruneNetworks(options: {}, callback: Callback): void; + pruneNetworks(callback: Callback): void; + info(callback: Callback): void; version(callback: Callback): void; @@ -638,6 +837,8 @@ declare class Dockerode { swarmUpdate(options: {}, callback: Callback): void; + swarmInspect(callback: Callback): void; + modem: any; } diff --git a/types/dragster/dragster-tests.ts b/types/dragster/dragster-tests.ts index a05d06e1dd..12b069362e 100644 --- a/types/dragster/dragster-tests.ts +++ b/types/dragster/dragster-tests.ts @@ -1,7 +1,7 @@ import Dragster = require("dragster"); -var dropzone = document.getElementById("my-dropzone") as HTMLElement; -var dragster = new Dragster(dropzone); +const dropzone = document.getElementById("my-dropzone") as HTMLElement; +const dragster = new Dragster(dropzone); dragster.removeListeners(); -dragster.reset(); \ No newline at end of file +dragster.reset(); diff --git a/types/dragster/index.d.ts b/types/dragster/index.d.ts index c02f510084..cc1e8e85b8 100644 --- a/types/dragster/index.d.ts +++ b/types/dragster/index.d.ts @@ -20,4 +20,4 @@ declare var Dragster: Dragster.DragsterStatic; export = Dragster; // Support as a global -export as namespace Dragster; \ No newline at end of file +export as namespace Dragster; diff --git a/types/dropkickjs/dropkickjs-tests.ts b/types/dropkickjs/dropkickjs-tests.ts index 206554da09..72006e1b6d 100644 --- a/types/dropkickjs/dropkickjs-tests.ts +++ b/types/dropkickjs/dropkickjs-tests.ts @@ -1,11 +1,11 @@ // constructor -var constructorNoOptions = new Dropkick('#my-select'); -var constructorNoOptions2 = new Dropkick(new HTMLSelectElement()); -var constructorOptions = new Dropkick('#my-select', {}); -var constructorOptions2 = new Dropkick(new HTMLSelectElement(), {}); +const constructorNoOptions = new Dropkick('#my-select'); +const constructorNoOptions2 = new Dropkick(new HTMLSelectElement()); +const constructorOptions = new Dropkick('#my-select', {}); +const constructorOptions2 = new Dropkick(new HTMLSelectElement(), {}); // options -var options: DropkickOptions = { +const options: DropkickOptions = { disabled: true, form: new HTMLFormElement(), length: 1, @@ -20,20 +20,20 @@ var options: DropkickOptions = { open() { }, initialize: () => { } }; -var withFullOptions = new Dropkick('#test', options); +const withFullOptions = new Dropkick('#test', options); -var dk = new Dropkick('#test'); +const dk = new Dropkick('#test'); // fields (same as options) -var o1 = dk.disabled; -var o2 = dk.form; -var o3 = dk.length; -var o4 = dk.mobile; -var o5 = dk.multiple; -var o6 = dk.options; -var o7 = dk.selectedIndex; -var o8 = dk.selectedOptions; -var o9 = dk.value; +const o1 = dk.disabled; +const o2 = dk.form; +const o3 = dk.length; +const o4 = dk.mobile; +const o5 = dk.multiple; +const o6 = dk.options; +const o7 = dk.selectedIndex; +const o8 = dk.selectedOptions; +const o9 = dk.value; // methods dk.add('new'); @@ -53,7 +53,7 @@ dk.focus(); dk.hide(4); dk.hide(4, false); -var node = dk.item(4); +const node = dk.item(4); dk.open(); @@ -64,18 +64,18 @@ dk.remove(4); dk.reset(); dk.reset(true); -var words = dk.search("qwer", "fuzzy"); +const words = dk.search("qwer", "fuzzy"); -var node2 = dk.select(4); -var node3 = dk.select("AL"); -var node4 = dk.select(4, true); +const node2 = dk.select(4); +const node3 = dk.select("AL"); +const node4 = dk.select(4, true); -var node5 = dk.selectOne(4); -var node6 = dk.selectOne(4, true); +const node5 = dk.selectOne(4); +const node6 = dk.selectOne(4, true); // real life example -var fieldValue = ''; -var selectOptions: DropkickOptions = { +let fieldValue = ''; +const selectOptions: DropkickOptions = { open(this: Dropkick) { const optionsList = ( this).data.elem.lastChild; // undocumented but useful data field if (optionsList.scrollWidth > optionsList.offsetWidth) { @@ -86,4 +86,4 @@ var selectOptions: DropkickOptions = { fieldValue = select.value; } }; -var select = new Dropkick('#select', options); \ No newline at end of file +const select = new Dropkick('#select', options); diff --git a/types/dropkickjs/index.d.ts b/types/dropkickjs/index.d.ts index 1e0a4f4acf..a7211070d4 100644 --- a/types/dropkickjs/index.d.ts +++ b/types/dropkickjs/index.d.ts @@ -14,10 +14,10 @@ interface DropkickOptions { selectedOptions?: string[]; value?: string; - change?: () => void; - close?: () => void; - initialize?: () => void; - open?: () => void; + change?(): void; + close?(): void; + initialize?(): void; + open?(): void; } declare class Dropkick { @@ -48,4 +48,4 @@ declare class Dropkick { selectedIndex: number; selectedOptions: string[]; value: string; -} \ No newline at end of file +} diff --git a/types/duplexer2/duplexer2-tests.ts b/types/duplexer2/duplexer2-tests.ts index cfc945adb7..d410a3eb52 100644 --- a/types/duplexer2/duplexer2-tests.ts +++ b/types/duplexer2/duplexer2-tests.ts @@ -1,8 +1,8 @@ import stream = require("stream"); import duplexer2 = require("duplexer2"); -const writable = new stream.Writable({ objectMode: true }), - readable = new stream.Readable({ objectMode: true }); +const writable = new stream.Writable({ objectMode: true }); +const readable = new stream.Readable({ objectMode: true }); writable.once("finish", () => { setTimeout(() => { @@ -30,4 +30,4 @@ duplex.write("oh, hi there", () => { duplex.end("", () => { console.log("finished ending"); -}); \ No newline at end of file +}); diff --git a/types/ecurve/ecurve-tests.ts b/types/ecurve/ecurve-tests.ts index ced84ef8aa..e7f730446b 100644 --- a/types/ecurve/ecurve-tests.ts +++ b/types/ecurve/ecurve-tests.ts @@ -4,8 +4,7 @@ import crypto = require('crypto'); import BigInteger = require('bigi'); import cs = require('coinstring'); - -var ecparams = ecurve.getCurveByName('secp256k1'); +let ecparams = ecurve.getCurveByName('secp256k1'); console.log(ecparams.n.toString(16)); // => fffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141 console.log(ecparams.G.getEncoded().toString('hex')); // getEncoded() returns type 'Buffer' instead of 'BigInteger' @@ -13,15 +12,14 @@ console.log(ecparams.G.getEncoded().toString('hex')); // getEncoded() returns ty console.log(ecparams.h.toString(16)); // => 1 +const privateKey = new Buffer("1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd", 'hex'); -var privateKey = new Buffer("1184cd2cdd640ca42cfc3a091c51d549b2f016d454b2774019c2b2d2e08529fd", 'hex'); +ecparams = ecurve.getCurveByName('secp256k1'); +const curvePt = ecparams.G.multiply(BigInteger.fromBuffer(privateKey)); +const x = curvePt.affineX.toBuffer(32); +const y = curvePt.affineY.toBuffer(32); -var ecparams = ecurve.getCurveByName('secp256k1'); -var curvePt = ecparams.G.multiply(BigInteger.fromBuffer(privateKey)); -var x = curvePt.affineX.toBuffer(32); -var y = curvePt.affineY.toBuffer(32); - -var publicKey = Buffer.concat([new Buffer([0x04]), x, y]); +let publicKey = Buffer.concat([new Buffer([0x04]), x, y]); console.log(publicKey.toString('hex')); // => 04d0988bfa799f7d7ef9ab3de97ef481cd0f75d2367ad456607647edde665d6f6fbdd594388756a7beaf73b4822bc22d36e9bda7db82df2b8b623673eefc0b7495 @@ -35,8 +33,8 @@ publicKey = curvePt.getEncoded(true); // true forces compressed public key console.log(publicKey.toString('hex')); // => 03d0988bfa799f7d7ef9ab3de97ef481cd0f75d2367ad456607647edde665d6f6f -var sha = crypto.createHash('sha256').update(publicKey).digest(); -var pubkeyHash = crypto.createHash('rmd160').update(sha).digest(); +const sha = crypto.createHash('sha256').update(publicKey).digest(); +const pubkeyHash = crypto.createHash('rmd160').update(sha).digest(); // pubkeyHash of compressed public key console.log(pubkeyHash.toString('hex')); @@ -50,4 +48,4 @@ console.log(cs.encode(privateKey, 0x80)); // <--- 0x80 is for private addresses // => 5Hx15HFGyep2CfPxsJKe2fXJsCVn5DEiyoeGGF6JZjGbTRnqfiD console.log(cs.encode(Buffer.concat([privateKey, new Buffer([0])]), 0x80)); // <-- compressed private address -// => KwomKti1X3tYJUUMb1TGSM2mrZk1wb1aHisUNHCQXTZq5aqzCxDY \ No newline at end of file +// => KwomKti1X3tYJUUMb1TGSM2mrZk1wb1aHisUNHCQXTZq5aqzCxDY diff --git a/types/ember/tslint.json b/types/ember/tslint.json index c91d42f0b2..9f4a74357e 100644 --- a/types/ember/tslint.json +++ b/types/ember/tslint.json @@ -3,6 +3,7 @@ "rules": { // Heavy use of Function type in this older package. "ban-types": false, + "jsdoc-format": false, "no-misused-new": false, // not sure what this means "no-single-declare-module": false diff --git a/types/emojione/index.d.ts b/types/emojione/index.d.ts index 48b55e87cd..22f3f0b191 100644 --- a/types/emojione/index.d.ts +++ b/types/emojione/index.d.ts @@ -5,15 +5,15 @@ export as namespace emojione; -export var sprites: boolean; -export var imagePathPNG: string; -export var imagePathSVG: string; -export var imagePathSVGSprites: string; -export var imageType: 'png' | 'svg'; -export var unicodeAlt: boolean; -export var ascii: boolean; -export var unicodeRegexp: string; -export var cacheBustParam: string; +export let sprites: boolean; +export let imagePathPNG: string; +export let imagePathSVG: string; +export let imagePathSVGSprites: string; +export let imageType: 'png' | 'svg'; +export let unicodeAlt: boolean; +export let ascii: boolean; +export let unicodeRegexp: string; +export let cacheBustParam: string; export function toShort(str: string): string; export function toImage(str: string): string; export function shortnameToImage(str: string): string; diff --git a/types/enzyme/enzyme-tests.tsx b/types/enzyme/enzyme-tests.tsx index c7323766f7..08ab6a5c15 100644 --- a/types/enzyme/enzyme-tests.tsx +++ b/types/enzyme/enzyme-tests.tsx @@ -26,16 +26,15 @@ const MyStatelessComponent = (props: StatelessProps) => ; // ShallowWrapper namespace ShallowWrapperTest { - var shallowWrapper: ShallowWrapper = + let shallowWrapper: ShallowWrapper = shallow(); - var reactElement: ReactElement, - objectVal: {}, - boolVal: boolean, - stringVal: string, - numOrStringVal: number | string, - elementWrapper: ShallowWrapper, {}>, - statelessWrapper: ShallowWrapper; + let reactElement: ReactElement; + let boolVal: boolean; + let stringVal: string; + let numOrStringVal: number | string; + let elementWrapper: ShallowWrapper, {}>; + let statelessWrapper: ShallowWrapper; function test_props_state_inferring() { let wrapper: ShallowWrapper; @@ -257,7 +256,7 @@ namespace ShallowWrapperTest { } function test_instance() { - var myComponent: MyComponent = shallowWrapper.instance(); + const myComponent: MyComponent = shallowWrapper.instance(); } function test_update() { @@ -282,7 +281,7 @@ namespace ShallowWrapperTest { } function test_map() { - var arrayNumbers: number[] = + const arrayNumbers: number[] = shallowWrapper.map(wrapper => wrapper.props().numberProp); } @@ -331,18 +330,16 @@ namespace ShallowWrapperTest { } } - // ReactWrapper namespace ReactWrapperTest { - var reactWrapper: ReactWrapper = + let reactWrapper: ReactWrapper = mount(); - var reactElement: ReactElement, - objectVal: {}, - boolVal: boolean, - stringVal: string, - elementWrapper: ReactWrapper, {}>, - statelessWrapper: ReactWrapper; + let reactElement: ReactElement; + let boolVal: boolean; + let stringVal: string; + let elementWrapper: ReactWrapper, {}>; + let statelessWrapper: ReactWrapper; function test_prop_state_inferring() { let wrapper: ReactWrapper; @@ -564,7 +561,7 @@ namespace ReactWrapperTest { } function test_instance() { - var myComponent: MyComponent = reactWrapper.instance(); + const myComponent: MyComponent = reactWrapper.instance(); } function test_update() { @@ -589,7 +586,7 @@ namespace ReactWrapperTest { } function test_map() { - var arrayNumbers: number[] = + const arrayNumbers: number[] = reactWrapper.map(wrapper => wrapper.props().numberProp); } diff --git a/types/enzyme/index.d.ts b/types/enzyme/index.d.ts index abb57e36ef..c6e78fda11 100644 --- a/types/enzyme/index.d.ts +++ b/types/enzyme/index.d.ts @@ -203,7 +203,7 @@ interface CommonWrapper { * * NOTE: can only be called on a wrapper instance that is also the root instance. * @param state - * @param [callback] + * @param [callback] */ setState(state: Pick, callback?: () => void): this; @@ -216,8 +216,8 @@ interface CommonWrapper { * Returns itself. * * NOTE: can only be called on a wrapper instance that is also the root instance. - * @param props - * @param [callback] + * @param props + * @param [callback] */ setProps(props: Pick): this; diff --git a/types/es6-weak-map/es6-weak-map-tests.ts b/types/es6-weak-map/es6-weak-map-tests.ts index 68f5ea7f43..afea19458a 100644 --- a/types/es6-weak-map/es6-weak-map-tests.ts +++ b/types/es6-weak-map/es6-weak-map-tests.ts @@ -2,11 +2,11 @@ import WeakMap = require('es6-weak-map'); new WeakMap<{}, string>(); -var tuples: Array<[number, string]> = [ [0, 'foo'], [1, 'bar'] ]; +const tuples: Array<[number, string]> = [ [0, 'foo'], [1, 'bar'] ]; new WeakMap(tuples); -var map = new WeakMap<{}, string>(); -var obj = {}; +const map = new WeakMap<{}, string>(); +const obj = {}; map.set(obj, 'foo'); map.get(obj); diff --git a/types/expect/expect-tests.ts b/types/expect/expect-tests.ts index c4312d1ada..6238a63c60 100644 --- a/types/expect/expect-tests.ts +++ b/types/expect/expect-tests.ts @@ -32,7 +32,8 @@ describe('createSpy', () => { }); describe('A spy', () => { - let targetContext: any, targetArguments: any; + let targetContext: any; + let targetArguments: any; const target = { method() { targetContext = this; @@ -88,7 +89,8 @@ describe('A spy', () => { }); describe('that calls some other function', () => { - let otherContext: any, otherArguments: any; + let otherContext: any; + let otherArguments: any; function otherFn() { otherContext = this; otherArguments = Array.prototype.slice.call(arguments, 0); diff --git a/types/express-mysql-session/index.d.ts b/types/express-mysql-session/index.d.ts index 0e86b9b077..f8d6282ecd 100644 --- a/types/express-mysql-session/index.d.ts +++ b/types/express-mysql-session/index.d.ts @@ -30,7 +30,6 @@ declare namespace MySQLStore { } declare class MySQLStore { - /** * @param {MySQLStore.Options} options * @param {any} connection? diff --git a/types/express-rate-limit/express-rate-limit-tests.ts b/types/express-rate-limit/express-rate-limit-tests.ts index 624a2da10d..fab5badeb8 100644 --- a/types/express-rate-limit/express-rate-limit-tests.ts +++ b/types/express-rate-limit/express-rate-limit-tests.ts @@ -17,8 +17,8 @@ const createAccountLimiter = new RateLimit({ class SomeStore implements RateLimit.Store { incr(key: string, cb: RateLimit.StoreIncrementCallback) { } resetAll() { } - resetKey(key: string) { }; -}; + resetKey(key: string) { } +} const limiterWithStore = new RateLimit({ store: new SomeStore() diff --git a/types/express-rate-limit/index.d.ts b/types/express-rate-limit/index.d.ts index ce09dbbf51..54bdacb936 100644 --- a/types/express-rate-limit/index.d.ts +++ b/types/express-rate-limit/index.d.ts @@ -9,20 +9,20 @@ declare namespace RateLimit { type StoreIncrementCallback = (err?: {}, hits?: number) => void; interface Store { - incr: (key: string, cb: StoreIncrementCallback) => void; - resetAll: () => void; - resetKey: (key: string) => void; + incr(key: string, cb: StoreIncrementCallback): void; + resetAll(): void; + resetKey(key: string): void; } interface Options { delayAfter?: number; delayMs?: number; - handlers?: () => any; + handlers?(): any; headers?: boolean; - keyGenerator?: () => string; + keyGenerator?(): string; max?: number; message?: string; - skip?: () => boolean; + skip?(): boolean; statusCode?: number; store?: Store; windowMs?: number; diff --git a/types/extract-zip/index.d.ts b/types/extract-zip/index.d.ts index 9edd2fcb31..6008fbce61 100644 --- a/types/extract-zip/index.d.ts +++ b/types/extract-zip/index.d.ts @@ -8,7 +8,7 @@ declare namespace extract { dir?: string; defaultDirMode?: number; defaultFileMode?: number; - onEntry?: (entry: any, zipfile: any) => void; + onEntry?(entry: any, zipfile: any): void; } } diff --git a/types/f1/f1-tests.ts b/types/f1/f1-tests.ts index 8bfbbfb080..0934b097e3 100644 --- a/types/f1/f1-tests.ts +++ b/types/f1/f1-tests.ts @@ -1,5 +1,5 @@ import F1 = require("f1"); -var ui = F1(); +const ui = F1(); ui.states({ out: { @@ -23,8 +23,6 @@ ui.states({ } }); - - ui.transitions( [ { from: 'idle', to: 'rollOver', animation: { duration: 0.25 } }, { from: 'rollOver', to: 'idle', animation: { duration: 0.1 } } diff --git a/types/f1/index.d.ts b/types/f1/index.d.ts index 82c5cf8c4d..f463c1e97e 100644 --- a/types/f1/index.d.ts +++ b/types/f1/index.d.ts @@ -6,8 +6,8 @@ /// interface F1Options { - onState?: (...args: any[]) => void; - onUpdate?: (...args: any[]) => void; + onState?(...args: any[]): void; + onUpdate?(...args: any[]): void; name: string; diff --git a/types/fabric/fabric-tests.ts b/types/fabric/fabric-tests.ts index e94b676104..62c0726e16 100644 --- a/types/fabric/fabric-tests.ts +++ b/types/fabric/fabric-tests.ts @@ -33,8 +33,10 @@ function sample1() { } function sample2() { - let dot: fabric.Circle, i: number; - let t1: number, t2: number; + let dot: fabric.Circle; + let i: number; + let t1: number; + let t2: number; const startTimer = () => { t1 = new Date().getTime(); return t1; @@ -42,16 +44,16 @@ function sample2() { const stopTimer = () => { t2 = new Date().getTime(); return t2 - t1; - }, - getRandomInt = fabric.util.getRandomInt, - rainbow = ["#ffcc66", "#ccff66", "#66ccff", "#ff6fcf", "#ff6666"], - rainbowEnd = rainbow.length - 1; + }; + const getRandomInt = fabric.util.getRandomInt; + const rainbow = ["#ffcc66", "#ccff66", "#66ccff", "#ff6fcf", "#ff6666"]; + const rainbowEnd = rainbow.length - 1; // // Rendering canvas #1 // - const canvas1 = new fabric.Canvas('c1', { backgroundColor: "#000" }), - results1 = document.getElementById('results-c1'); + const canvas1 = new fabric.Canvas('c1', { backgroundColor: "#000" }); + const results1 = document.getElementById('results-c1'); startTimer(); for (i = 100; i >= 0; i--) { @@ -68,8 +70,8 @@ function sample2() { // // Rendering canvas #2 // - const canvas2 = new fabric.Canvas('c2', { backgroundColor: "#000", renderOnAddRemove: false }), - results2 = document.getElementById('results-c2'); + const canvas2 = new fabric.Canvas('c2', { backgroundColor: "#000", renderOnAddRemove: false }); + const results2 = document.getElementById('results-c2'); startTimer(); for (i = 1000; i >= 0; i--) { @@ -101,8 +103,8 @@ function sample3() { } } - const canvas = new fabric.Canvas('c', { backgroundImage: '../lib/bg.png' }), - f = fabric.Image.filters; + const canvas = new fabric.Canvas('c', { backgroundImage: '../lib/bg.png' }); + const f = fabric.Image.filters; canvas.on({ 'object:selected': () => { @@ -296,12 +298,12 @@ function sample5() { const canvas = new fabric.Canvas('c', { selection: false }); - const line = makeLine([250, 125, 250, 175]), - line2 = makeLine([250, 175, 250, 250]), - line3 = makeLine([250, 250, 300, 350]), - line4 = makeLine([250, 250, 200, 350]), - line5 = makeLine([250, 175, 175, 225]), - line6 = makeLine([250, 175, 325, 225]); + const line = makeLine([250, 125, 250, 175]); + const line2 = makeLine([250, 175, 250, 250]); + const line3 = makeLine([250, 250, 300, 350]); + const line4 = makeLine([250, 250, 200, 350]); + const line5 = makeLine([250, 175, 175, 225]); + const line6 = makeLine([250, 175, 325, 225]); canvas.add(line, line2, line3, line4, line5, line6); @@ -341,9 +343,9 @@ function sample6() { const p = canvas.getPointer(options.e); canvas.forEachObject(obj => { - const distX = Math.abs(p.x - obj.left), - distY = Math.abs(p.y - obj.top), - dist = Math.round(Math.sqrt(Math.pow(distX, 2) + Math.pow(distY, 2))); + const distX = Math.abs(p.x - obj.left); + const distY = Math.abs(p.y - obj.top); + const dist = Math.round(Math.sqrt(Math.pow(distX, 2) + Math.pow(distY, 2))); obj.setOpacity(1 / (dist / 20)); }); }); @@ -436,13 +438,13 @@ function sample8() { element = element.parentNode; } - const className = element.className, - offset = 50, - left = fabric.util.getRandomInt(0 + offset, 700 - offset), - top = fabric.util.getRandomInt(0 + offset, 500 - offset), - angle = fabric.util.getRandomInt(-20, 40), - width = fabric.util.getRandomInt(30, 50), - opacity = ((min: number, max: number) => Math.random() * (max - min) + min)(0.5, 1); + const className = element.className; + const offset = 50; + const left = fabric.util.getRandomInt(0 + offset, 700 - offset); + const top = fabric.util.getRandomInt(0 + offset, 500 - offset); + const angle = fabric.util.getRandomInt(-20, 40); + const width = fabric.util.getRandomInt(30, 50); + const opacity = ((min: number, max: number) => Math.random() * (max - min) + min)(0.5, 1); switch (className) { case 'rect': @@ -508,7 +510,7 @@ function sample8() { case 'shape': const id: any = element.id; - const match = /\d+$/.exec(id); + const match = /\d+$/.exec(id); if (match) { fabric.loadSVGFromURL('../assets/' + match[0] + '.svg', (objects, options) => { const loadedObject = fabric.util.groupSVGElements(objects, options); @@ -556,8 +558,8 @@ function sample8() { const removeSelectedEl = document.getElementById('remove-selected'); removeSelectedEl.onclick = () => { - const activeObject = canvas.getActiveObject(), - activeGroup = canvas.getActiveGroup(); + const activeObject = canvas.getActiveObject(); + const activeGroup = canvas.getActiveGroup(); if (activeObject) { canvas.remove(activeObject); } else if (activeGroup) { @@ -579,8 +581,8 @@ function sample8() { }; }; - const supportsSlider = supportsInputOfType('range'), - supportsColorpicker = supportsInputOfType('color'); + const supportsSlider = supportsInputOfType('range'); + const supportsColorpicker = supportsInputOfType('color'); if (supportsSlider()) { (() => { @@ -603,8 +605,8 @@ function sample8() { canvas.calcOffset(); slider.onchange = function() { - const activeObject = canvas.getActiveObject(), - activeGroup = canvas.getActiveGroup(); + const activeObject = canvas.getActiveObject(); + const activeGroup = canvas.getActiveGroup(); if (activeObject || activeGroup) { (activeObject || activeGroup).setOpacity(parseInt(this.value, 10) / 100); @@ -634,8 +636,8 @@ function sample8() { canvas.calcOffset(); colorpicker.onchange = function() { - const activeObject = canvas.getActiveObject(), - activeGroup = canvas.getActiveGroup(); + const activeObject = canvas.getActiveObject(); + const activeGroup = canvas.getActiveGroup(); if (activeObject || activeGroup) { (activeObject || activeGroup).setFill(this.value); @@ -748,10 +750,10 @@ function sample8() { } }); - const drawingModeEl = document.getElementById('drawing-mode'), - drawingOptionsEl = document.getElementById('drawing-mode-options'), - drawingColorEl = document.getElementById('drawing-color'), - drawingLineWidthEl = document.getElementById('drawing-line-width'); + const drawingModeEl = document.getElementById('drawing-mode'); + const drawingOptionsEl = document.getElementById('drawing-mode-options'); + const drawingColorEl = document.getElementById('drawing-color'); + const drawingLineWidthEl = document.getElementById('drawing-line-width'); drawingModeEl.onclick = () => { const canvasWithDrawingMode: any = canvas; diff --git a/types/fabric/index.d.ts b/types/fabric/index.d.ts index 18b9c41e82..ca99080bad 100644 --- a/types/fabric/index.d.ts +++ b/types/fabric/index.d.ts @@ -1028,7 +1028,7 @@ export class StaticCanvas { * @param {Number|String} value Value to set width to * @param {Object} [options] Options object */ - setWidth(value: number|string, options?: ICanvasDimensionsOptions): StaticCanvas + setWidth(value: number|string, options?: ICanvasDimensionsOptions): StaticCanvas; /** * Sets height of this canvas instance @@ -1281,13 +1281,13 @@ export class StaticCanvas { * Straightens object, then rerenders canvas * @param {fabric.Object} object Object to straighten */ - straightenObject(object: Object): StaticCanvas + straightenObject(object: Object): StaticCanvas; /** * Same as straightenObject, but animated * @param {fabric.Object} object Object to straighten */ - fxStraightenObject(object: Object): StaticCanvas + fxStraightenObject(object: Object): StaticCanvas; static EMPTY_JSON: string; /** @@ -1512,7 +1512,7 @@ export class Canvas { /** * Removes all event listeners */ - removeListeners(): void + removeListeners(): void; static EMPTY_JSON: string; /** @@ -2344,7 +2344,7 @@ export class Object { * @param {Object|Function} value Property value (if function, the value is passed into it and its return value is used as a new one) */ set(key: string, value: any|Function): Object; - /** + /** * Sets property to a given value. * When changing position/dimension -related properties (left, top, scale, angle, etc.) `set` does not update position of object's borders/controls. * If you need to update those, call `setCoords()`. @@ -3966,7 +3966,7 @@ export class CircleBrush extends BaseBrush { * @param {Object} pointer * @return {fabric.Point} Just added pointer point */ - addPoint(pointer: any): Point + addPoint(pointer: any): Point; } export class SprayBrush extends BaseBrush { @@ -3999,7 +3999,7 @@ export class SprayBrush extends BaseBrush { /** * @param {Object} pointer */ - addSprayChunk(pointer: any): void + addSprayChunk(pointer: any): void; } export class PatternBrush extends PencilBrush { getPatternSrc(): HTMLCanvasElement; diff --git a/types/falcor/index.d.ts b/types/falcor/index.d.ts index 44d9118ca2..f5cea280a0 100644 --- a/types/falcor/index.d.ts +++ b/types/falcor/index.d.ts @@ -39,21 +39,21 @@ export { * Every DataSource is associated with a single JSON Graph object. * Models execute JSON Graph operations (get, set, and call) to retrieve values from the DataSource’s JSON Graph object. * DataSources may retrieve JSON Graph information from anywhere, including device memory, a remote machine, or even a lazily-run computation. - **/ + */ export abstract class DataSource { /** * The get method retrieves values from the DataSource's associated JSONGraph object. - **/ + */ get(pathSets: PathSet[]): Observable; /** * The set method accepts values to set in the DataSource's associated JSONGraph object. - **/ + */ set(jsonGraphEnvelope: JSONGraphEnvelope): Observable; /** * Invokes a function in the DataSource's JSONGraph object. - **/ + */ call(functionPath: Path, args?: any[], refSuffixes?: PathSet[], thisPaths?: PathSet[]): Observable; } @@ -73,30 +73,30 @@ interface ModelOptions { /** * This callback is invoked when the Model's cache is changed. - **/ + */ type ModelOnChange = () => void; /** * This function is invoked on every JSONGraph Error retrieved from the DataSource. This function allows Error objects to be transformed before being stored in the Model's cache. - **/ + */ type ModelErrorSelector = (jsonGraphError: any) => any; /** * This function is invoked every time a value in the Model cache is about to be replaced with a new value. * If the function returns true, the existing value is replaced with a new value and the version flag on all of the value's ancestors in the tree are incremented. - **/ + */ type ModelComparator = (existingValue: any, newValue: any) => boolean; /** * A Model object is used to execute commands against a {@link JSONGraph} object * {@link Model}s can work with a local JSONGraph cache, or it can work with a remote {@link JSONGraph} object through a {@link DataSource}. - **/ + */ export class Model { constructor(options?: ModelOptions); /** * The get method retrieves several {@link Path}s or {@link PathSet}s from a {@link Model}. The get method loads each value into a JSON object and returns in a ModelResponse. - **/ + */ get(...path: Array): ModelResponse>; get(...path: Array): ModelResponse>; @@ -104,7 +104,7 @@ export class Model { * Sets the value at one or more places in the JSONGraph model. * The set method accepts one or more {@link PathValue}s, each of which is a combination of a location in the document and the value to place there. * In addition to accepting {@link PathValue}s, the set method also returns the values after the set operation is complete. - **/ + */ set(...args: PathValue[]): ModelResponse>; set(...args: PathValue[]): ModelResponse>; set(jsonGraph: JSONGraph): ModelResponse>; @@ -112,12 +112,12 @@ export class Model { /** * The preload method retrieves several {@link Path}s or {@link PathSet}s from a {@link Model} and loads them into the Model cache. - **/ + */ preload(...path: PathSet[]): void; /** * Invokes a function in the JSON Graph. - **/ + */ // NOTE: In http://netflix.github.io/falcor/doc/Model.html#call, it says that refPaths should be an PathSet[]. // However, model implementation returns an error with setting refPaths as PathSet[] and it works with refPaths as PathSet. // So refPaths is defined as a PathSet in this .d.ts. @@ -126,7 +126,7 @@ export class Model { /** * The invalidate method synchronously removes several {@link Path}s or {@link PathSet}s from a {@link Model} cache. - **/ + */ invalidate(...path: PathSet[]): void; /** @@ -136,78 +136,78 @@ export class Model { * - Expose only a fragment of the {@link JSONGraph} to components, rather than the entire graph * - Hide the location of a {@link JSONGraph} fragment from components * - Optimize for executing multiple operations and path looksup at/below the same location in the {@link JSONGraph} - **/ + */ deref(responseObject: any): Model; /** * Get data for a single {@link Path}. - **/ + */ getValue(path: string | Path): ModelResponse; getValue(path: string | Path): ModelResponse; /** * Set value for a single {@link Path}. - **/ + */ setValue(path: string | Path, value: any): ModelResponse; setValue(path: string | Path, value: any): ModelResponse; /** * Set the local cache to a {@link JSONGraph} fragment. This method can be a useful way of mocking a remote document, or restoring the local cache from a previously stored state. - **/ + */ setCache(jsonGraph: JSONGraph): void; /** * Get the local {@link JSONGraph} cache. This method can be a useful to store the state of the cache. - **/ + */ getCache(...path: PathSet[]): JSONGraph; /** * Retrieves a number which is incremented every single time a value is changed underneath the Model or the object at an optionally-provided Path beneath the Model. - **/ + */ getVersion(path?: Path): number; /** * Returns a clone of the {@link Model} that enables batching. Within the configured time period, paths for get operations are collected and sent to the {@link DataSource} in a batch. * Batching can be more efficient if the {@link DataSource} access the network, potentially reducing the number of HTTP requests to the server. - **/ + */ batch(schedulerOrDelay?: number | Scheduler): Model; // FIXME what's a valid type for scheduler? /** * Returns a clone of the {@link Model} that disables batching. This is the default mode. Each get operation will be executed on the {@link DataSource} separately. - **/ + */ unbatch(): Model; /** * Returns a clone of the {@link Model} that treats errors as values. Errors will be reported in the same callback used to report data. * Errors will appear as objects in responses, rather than being sent to the {@link Observable~onErrorCallback} callback of the {@link ModelResponse}. - **/ + */ treatErrorsAsValues(): Model; /** * Adapts a Model to the {@link DataSource} interface. - **/ + */ asDataSource(): DataSource; /** * Returns a clone of the {@link Model} that boxes values returning the wrapper ({@link Atom}, {@link Reference}, or {@link Error}), rather than the value inside it. * This allows any metadata attached to the wrapper to be inspected. - **/ + */ boxValues(): Model; /** * Returns a clone of the {@link Model} that unboxes values, returning the value inside of the wrapper ({@link Atom}, {@link Reference}, or {@link Error}), rather than the wrapper itself. * This is the default mode. - **/ + */ unboxValues(): Model; /** * Returns a clone of the {@link Model} that only uses the local {@link JSONGraph} and never uses a {@link DataSource} to retrieve missing paths. - **/ + */ withoutDataSource(): Model; /** * Returns the {@link Path} to the object within the JSON Graph that this Model references. - **/ + */ getPath(): Path; } @@ -237,38 +237,38 @@ export class Observable{ * An Observable is like a pipe of water that is closed. * When forEach is called, we open the valve and the values within are pushed at us. * These values can be received using either callbacks or an {@link Observer} object. - **/ + */ forEach(onNext?: ObservableOnNextCallback, onError?: ObservableOnErrorCallback , onCompleted?: ObservableOnCompletedCallback ): Subscription; /** * The subscribe method is a synonym for {@link Observable.prototype.forEach} and triggers the execution of the Observable, causing the values within to be pushed to a callback. * An Observable is like a pipe of water that is closed. * When forEach is called, we open the valve and the values within are pushed at us. These values can be received using either callbacks or an {@link Observer} object. - **/ + */ subscribe(onNext?: ObservableOnNextCallback, onError?: ObservableOnErrorCallback , onCompleted?: ObservableOnCompletedCallback ): Subscription; } /** * This callback accepts a value that was emitted while evaluating the operation underlying the {@link Observable} stream. - **/ + */ type ObservableOnNextCallback = (value: T) => void; /** * This callback accepts an error that occurred while evaluating the operation underlying the {@link Observable} stream. * When this callback is invoked, the {@link Observable} stream ends and no more values will be received by the {@link Observable~onNextCallback}. - **/ + */ type ObservableOnErrorCallback = (error: Error) => void; /** * This callback is invoked when the {@link Observable} stream ends. * When this callback is invoked the {@link Observable} stream has ended, and therefore the {@link Observable~onNextCallback} will not receive any more values. - **/ + */ type ObservableOnCompletedCallback = () => void; export class Subscription { /** * When this method is called on the Subscription, the Observable that created the Subscription will stop sending values to the callbacks passed when the Subscription was created. - **/ + */ dispose(): void; } diff --git a/types/fetch-jsonp/fetch-jsonp-tests.ts b/types/fetch-jsonp/fetch-jsonp-tests.ts index 6a0d58f513..a5effbc317 100644 --- a/types/fetch-jsonp/fetch-jsonp-tests.ts +++ b/types/fetch-jsonp/fetch-jsonp-tests.ts @@ -3,22 +3,20 @@ import * as fetchJsonp from 'fetch-jsonp'; /* Taken from https://github.com/camsong/fetch-jsonp/blob/v1.0.2/README.md */ fetchJsonp('/users.jsonp') - .then(function(response) { - return response.json(); - }).then(function(json) { + .then(response => response.json()) + .then(json => { console.log('parsed json', json); - }).catch(function(ex) { + }).catch(ex => { console.log('parsing failed', ex); }); fetchJsonp('/users.jsonp', { jsonpCallback: 'custom_callback' }) - .then(function(response) { - return response.json(); - }).then(function(json) { + .then(response => response.json()) + .then(json => { console.log('parsed json', json); - }).catch(function(ex) { + }).catch(ex => { console.log('parsing failed', ex); }); @@ -26,11 +24,10 @@ fetchJsonp('/users.jsonp', { timeout: 3000, jsonpCallback: 'custom_callback' }) - .then(function(response) { - return response.json(); - }).then(function(json) { + .then(response => response.json()) + .then(json => { console.log('parsed json', json); - }).catch(function(ex) { + }).catch(ex => { console.log('parsing failed', ex); }); @@ -39,10 +36,9 @@ const result = fetchJsonp('http://www.flickr.com/services/feeds/photos_public.gn jsonpCallback: 'jsoncallback', timeout: 3000 }); -result.then(function(response) { - return response.json(); -}).then(function(json) { +result.then(response => response.json()) +.then(json => { document.body.innerHTML = JSON.stringify(json); -})['catch'](function(ex) { +}).catch(ex => { document.body.innerHTML = 'failed:' + ex; }); diff --git a/types/fetch-mock/index.d.ts b/types/fetch-mock/index.d.ts index bda708ee55..650045e7ac 100644 --- a/types/fetch-mock/index.d.ts +++ b/types/fetch-mock/index.d.ts @@ -15,16 +15,16 @@ type MockMatcherFunction = (url: string, opts: MockRequest) => boolean; /** * Mock matcher. Can be one of following: * string: Either - * an exact url to match e.g. 'http://www.site.com/page.html' - * if the string begins with a `^`, the string following the `^` must - begin the url e.g. '^http://www.site.com' would match - 'http://www.site.com' or 'http://www.site.com/page.html' - * '*' to match any url - * RegExp: A regular expression to test the url against - * Function(url, opts): A function (returning a Boolean) that is passed the - url and opts fetch() is called with (or, if fetch() was called with one, - the Request instance) - */ + * * an exact url to match e.g. 'http://www.site.com/page.html' + * * if the string begins with a `^`, the string following the `^` must + * begin the url e.g. '^http://www.site.com' would match + * 'http://www.site.com' or 'http://www.site.com/page.html' + * * '*' to match any url + * RegExp: A regular expression to test the url against + * Function(url, opts): A function (returning a Boolean) that is passed the + * url and opts fetch() is called with (or, if fetch() was called with one, + * the Request instance) + */ type MockMatcher = string | RegExp | MockMatcherFunction; /** @@ -46,14 +46,14 @@ interface MockResponseObject { headers?: { [key: string]: string }; /** * If this property is present then a Promise rejected with the value - of throws is returned - */ + * of throws is returned + */ throws?: boolean; /** * This property determines whether or not the request body should be - JSON.stringified before being sent - * @default true - */ + * JSON.stringified before being sent + * @default true + */ sendAsJson?: boolean; } /** @@ -61,11 +61,11 @@ interface MockResponseObject { * number: Creates a response with this status * string: Creates a 200 response with the string as the response body * object: As long as the object is not a MockResponseObject it is - converted into a json string and returned as the body of a 200 response - * If MockResponseObject was given then it's used to configure response - * Function(url, opts): A function that is passed the url and opts fetch() - is called with and that returns any of the responses listed above - */ + * converted into a json string and returned as the body of a 200 response + * If MockResponseObject was given then it's used to configure response + * Function(url, opts): A function that is passed the url and opts fetch() + * is called with and that returns any of the responses listed above + */ type MockResponse = Response | Promise | number | Promise | string | Promise @@ -84,13 +84,13 @@ type MockResponseFunction = (url: string, opts: MockRequest) => MockResponse; interface MockOptions { /** * A unique string naming the route. Used to subsequently retrieve - references to the calls, grouped by name. - * @default matcher.toString() - * - * Note: If a non-unique name is provided no error will be thrown - (because names are optional, auto-generated ones may legitimately - clash) - */ + * references to the calls, grouped by name. + * @default matcher.toString() + * + * Note: If a non-unique name is provided no error will be thrown + * (because names are optional, auto-generated ones may legitimately + * clash) + */ name?: string; /** * http method to match @@ -106,10 +106,10 @@ interface MockOptions { response?: MockResponse | MockResponseFunction; /** * integer, n, limiting the number of times the matcher can be used. - If the route has already been called n times the route will be - ignored and the call to fetch() will fall through to be handled by - any other routes defined (which may eventually result in an error - if nothing matches it). + * If the route has already been called n times the route will be + * ignored and the call to fetch() will fall through to be handled by + * any other routes defined (which may eventually result in an error + * if nothing matches it). */ times?: number; } @@ -144,187 +144,187 @@ interface MockOptionsMethodHead extends MockOptions { interface FetchMockStatic { /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Calls to .mock() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Calls to .mock() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ mock(matcher: MockMatcher, response: MockResponse | MockResponseFunction, options?: MockOptions): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Calls to .mock() can be chained. - * @param options The route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Calls to .mock() can be chained. + * @param options The route to mock + */ mock(options: MockOptions): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() limited to being - called one time only. Calls to .once() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Optional additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() limited to being + * called one time only. Calls to .once() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Optional additional properties defining the route to mock + */ once(matcher: MockMatcher, response: MockResponse | MockResponseFunction, options?: MockOptions): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the GET - method. Calls to .get() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the GET + * method. Calls to .get() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ get(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodGet): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the GET - method and limited to being called one time only. Calls to .getOnce() - can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the GET + * method and limited to being called one time only. Calls to .getOnce() + * can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ getOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodGet): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the POST - method. Calls to .post() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the POST + * method. Calls to .post() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ post(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodPost): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the POST - method and limited to being called one time only. Calls to .postOnce() - can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the POST + * method and limited to being called one time only. Calls to .postOnce() + * can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ postOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodPost): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the PUT - method. Calls to .put() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the PUT + * method. Calls to .put() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ put(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodPut): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the PUT - method and limited to being called one time only. Calls to .putOnce() - can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the PUT + * method and limited to being called one time only. Calls to .putOnce() + * can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ putOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodPut): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the - DELETE method. Calls to .delete() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the + * DELETE method. Calls to .delete() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ delete(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodDelete): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the - DELETE method and limited to being called one time only. Calls to - .deleteOnce() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the + * DELETE method and limited to being called one time only. Calls to + * .deleteOnce() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ deleteOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodDelete): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the HEAD - method. Calls to .head() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the HEAD + * method. Calls to .head() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ head(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodHead): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the HEAD - method and limited to being called one time only. Calls to .headOnce() - can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the HEAD + * method and limited to being called one time only. Calls to .headOnce() + * can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ headOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodHead): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the PATCH - method. Calls to .patch() can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the PATCH + * method. Calls to .patch() can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ patch(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodHead): this; /** * Replaces fetch() with a stub which records its calls, grouped by - route, and optionally returns a mocked Response object or passes the - call through to fetch(). Shorthand for mock() restricted to the PATCH - method and limited to being called one time only. Calls to .patchOnce() - can be chained. - * @param matcher Condition for selecting which requests to mock - * @param response Configures the http response returned by the mock - * @param [options] Additional properties defining the route to mock - */ + * route, and optionally returns a mocked Response object or passes the + * call through to fetch(). Shorthand for mock() restricted to the PATCH + * method and limited to being called one time only. Calls to .patchOnce() + * can be chained. + * @param matcher Condition for selecting which requests to mock + * @param response Configures the http response returned by the mock + * @param [options] Additional properties defining the route to mock + */ patchOnce(matcher: MockMatcher, reponse: MockResponse | MockResponseFunction, options?: MockOptionsMethodHead): this; /** * Chainable method that defines how to respond to calls to fetch that - don't match any of the defined mocks. It accepts the same types of - response as a normal call to .mock(matcher, response). It can also - take an arbitrary function to completely customise behaviour of - unmatched calls. If .catch() is called without any parameters then - every unmatched call will receive a 200 response. - * @param [response] Configures the http response returned by the mock - */ + * don't match any of the defined mocks. It accepts the same types of + * response as a normal call to .mock(matcher, response). It can also + * take an arbitrary function to completely customise behaviour of + * unmatched calls. If .catch() is called without any parameters then + * every unmatched call will receive a 200 response. + * @param [response] Configures the http response returned by the mock + */ catch(response?: MockResponse | MockResponseFunction): this; /** * Chainable method that records the call history of unmatched calls, - but instead of responding with a stubbed response, the request is - passed through to native fetch() and is allowed to communicate - over the network. Similar to catch(). - */ + * but instead of responding with a stubbed response, the request is + * passed through to native fetch() and is allowed to communicate + * over the network. Similar to catch(). + */ spy(response?: MockResponse | MockResponseFunction): this; /** * Chainable method that restores fetch() to its unstubbed state and - clears all data recorded for its calls. - */ + * clears all data recorded for its calls. + */ restore(): this; /** @@ -334,8 +334,8 @@ interface FetchMockStatic { /** * Returns all calls to fetch, grouped by whether fetch-mock matched - them or not. - */ + * them or not. + */ calls(): MatchedRoutes; /** * Returns all calls to fetch matching matcherName. @@ -344,53 +344,53 @@ interface FetchMockStatic { /** * Returns a Boolean indicating whether fetch was called and a route - was matched (or a specific route if matcherName is passed). + * was matched (or a specific route if matcherName is passed). * @param [matcherName] either the name of a route or equal to - matcher.toString() for any unnamed route - */ + * matcher.toString() for any unnamed route + */ called(matcherName?: string): boolean; /** * Returns a Boolean indicating whether fetch was called the expected - number of times (or at least once if the route defines no expectation - is set) for every route (or for a specific route if matcherName is - passed). + * number of times (or at least once if the route defines no expectation + * is set) for every route (or for a specific route if matcherName is + * passed). * @param [matcherName] either the name of a route or equal to - matcher.toString() for any unnamed route - */ + * matcher.toString() for any unnamed route + */ done(matcherName?: string): boolean; /** * Returns the arguments for the last matched call to fetch (or the - last call to specific route is matcherName is passed). + * last call to specific route is matcherName is passed). * @param [matcherName] either the name of a route or equal to - matcher.toString() for any unnamed route + * matcher.toString() for any unnamed route */ lastCall(matcherName?: string): MockCall; /** * Returns the url for the last matched call to fetch (or the last - call to specific route is matcherName is passed). + * call to specific route is matcherName is passed). * @param [matcherName] either the name of a route or equal to - matcher.toString() for any unnamed route + * matcher.toString() for any unnamed route */ lastUrl(matcherName?: string): string; /** * Returns the options for the last matched call to fetch (or the - last call to a specific route is matcherName is passed). + * last call to a specific route is matcherName is passed). * @param [matcherName] either the name of a route or equal to - matcher.toString() for any unnamed route + * matcher.toString() for any unnamed route */ lastOptions(matcherName?: string): MockRequest; /** * Set some global config options, which include - * sendAsJson [default `true`] - by default fetchMock will - convert objects to JSON before sending. This is overrideable - for each call but for some scenarios, e.g. when dealing with a - lot of array buffers, it can be useful to default to `false` - */ + * sendAsJson [default `true`] - by default fetchMock will + * convert objects to JSON before sending. This is overrideable + * for each call but for some scenarios, e.g. when dealing with a + * lot of array buffers, it can be useful to default to `false` + */ configure(opts: {}): void; } diff --git a/types/fetch.io/index.d.ts b/types/fetch.io/index.d.ts index 966925b68f..2071e18a51 100644 --- a/types/fetch.io/index.d.ts +++ b/types/fetch.io/index.d.ts @@ -30,7 +30,7 @@ interface Options extends RequestInit { afterJSON?(body: any): void; } -declare class Request { +export class Request { constructor(method: TMethod, url: TUrl, options: Options) /** @@ -66,51 +66,51 @@ declare class Request { /** * Set Options */ - config(key: string, value: any): this + config(key: string, value: any): this; - config(opts: {[key: string]: any}): this + config(opts: {[key: string]: any}): this; /** * Set Header */ - set(key: string, value: any): this + set(key: string, value: any): this; - set(opts: {[key: string]: any}): this + set(opts: {[key: string]: any}): this; /** * Set Content-Type */ - type(type: 'json' | 'form' | 'urlencoded'): this + type(type: 'json' | 'form' | 'urlencoded'): this; /** * Add query string */ - query(object: {[key: string]: any}): this + query(object: {[key: string]: any}): this; /** * Send data */ - send(data: {[key: string]: any}): this + send(data: {[key: string]: any}): this; /** * ppend formData */ - append(key: string, value: string): this + append(key: string, value: string): this; /** * Get Response directly */ - then(resolve: (value?: Response) => void, reject?: (reason?: any) => void): Promise + then(resolve: (value?: Response) => void, reject?: (reason?: any) => void): Promise; /** * Make Response to JSON */ - json(strict?: boolean): Promise + json(strict?: boolean): Promise; /** * Make Response to string */ - text(): Promise + text(): Promise; } export default class Fetch extends Request { diff --git a/types/firmata/index.d.ts b/types/firmata/index.d.ts index a24fae435b..820e4d5c8b 100644 --- a/types/firmata/index.d.ts +++ b/types/firmata/index.d.ts @@ -32,69 +32,69 @@ declare class Board extends NodeJS.EventEmitter { firmware: Board.Firmware; settings: Board.Settings; protected transport: SerialPort; - reportVersion(callback: () => void): void - queryFirmware(callback: () => void): void - analogRead(pin: number, callback: (value: number) => void): void - analogWrite(pin: number, value: number): void - pwmWrite(pin: number, value: number): void - servoConfig(pin: number, min: number, max: number): void - servoWrite(pin: number, value: number): void - pinMode(pin: number, mode: Board.PIN_MODE): void - digitalWrite(pin: number, val: Board.PIN_STATE): void - digitalRead(pin: number, callback: (val: Board.PIN_STATE) => void): void - queryCapabilities(callback: () => void): void - queryAnalogMapping(callback: () => void): void - queryPinState(pin: number, callback: () => void): void + reportVersion(callback: () => void): void; + queryFirmware(callback: () => void): void; + analogRead(pin: number, callback: (value: number) => void): void; + analogWrite(pin: number, value: number): void; + pwmWrite(pin: number, value: number): void; + servoConfig(pin: number, min: number, max: number): void; + servoWrite(pin: number, value: number): void; + pinMode(pin: number, mode: Board.PIN_MODE): void; + digitalWrite(pin: number, val: Board.PIN_STATE): void; + digitalRead(pin: number, callback: (val: Board.PIN_STATE) => void): void; + queryCapabilities(callback: () => void): void; + queryAnalogMapping(callback: () => void): void; + queryPinState(pin: number, callback: () => void): void; // TODO untested --- TWW - sendString(str: string): void + sendString(str: string): void; // TODO untested --- TWW - sendI2CConfig(delay: number): void + sendI2CConfig(delay: number): void; // TODO untested --- TWW - i2cConfig(options: number|{ delay: number }): void + i2cConfig(options: number|{ delay: number }): void; // TODO untested --- TWW - sendI2CWriteRequest(slaveAddress: number, bytes: number[]): void + sendI2CWriteRequest(slaveAddress: number, bytes: number[]): void; // TODO untested --- TWW - i2cWrite(address: number, register: number, inBytes: number[]): void - i2cWrite(address: number, data: number[]): void + i2cWrite(address: number, register: number, inBytes: number[]): void; + i2cWrite(address: number, data: number[]): void; // TODO untested --- TWW - i2cWriteReg(address: number, register: number, byte: number): void + i2cWriteReg(address: number, register: number, byte: number): void; // TODO untested --- TWW - sendI2CReadRequest(address: number, numBytes: number, callback: () => void): void + sendI2CReadRequest(address: number, numBytes: number, callback: () => void): void; // TODO untested --- TWW - i2cRead(address: number, register: number, bytesToRead: number, callback: (data: number[]) => void): void - i2cRead(address: number, bytesToRead: number, callback: (data: number[]) => void): void + i2cRead(address: number, register: number, bytesToRead: number, callback: (data: number[]) => void): void; + i2cRead(address: number, bytesToRead: number, callback: (data: number[]) => void): void; // TODO untested --- TWW - i2cStop(options: number|{ bus: number, address: number }): void + i2cStop(options: number|{ bus: number, address: number }): void; // TODO untested --- TWW - i2cReadOnce(address: number, register: number, bytesToRead: number, callback: (data: number[]) => void): void - i2cReadOnce(address: number, bytesToRead: number, callback: (data: number[]) => void): void + i2cReadOnce(address: number, register: number, bytesToRead: number, callback: (data: number[]) => void): void; + i2cReadOnce(address: number, bytesToRead: number, callback: (data: number[]) => void): void; // TODO untested --- TWW - sendOneWireConfig(pin: number, enableParasiticPower: boolean): void + sendOneWireConfig(pin: number, enableParasiticPower: boolean): void; // TODO untested --- TWW - sendOneWireSearch(pin: number, callback: () => void): void + sendOneWireSearch(pin: number, callback: () => void): void; // TODO untested --- TWW - sendOneWireAlarmsSearch(pin: number, callback: () => void): void + sendOneWireAlarmsSearch(pin: number, callback: () => void): void; // TODO untested --- TWW - sendOneWireRead(pin: number, device: number, numBytesToRead: number, callback: () => void): void + sendOneWireRead(pin: number, device: number, numBytesToRead: number, callback: () => void): void; // TODO untested --- TWW - sendOneWireReset(pin: number): void + sendOneWireReset(pin: number): void; // TODO untested --- TWW - sendOneWireWrite(pin: number, device: number, data: number|number[]): void + sendOneWireWrite(pin: number, device: number, data: number|number[]): void; // TODO untested --- TWW - sendOneWireDelay(pin: number, delay: number): void + sendOneWireDelay(pin: number, delay: number): void; // TODO untested --- TWW sendOneWireWriteAndRead( pin: number, device: number, data: number|number[], numBytesToRead: number, - callback: (error?: Error, data?: number) => void): void - setSamplingInterval(interval: number): void - getSamplingInterval(): number - reportAnalogPin(pin: number, value: Board.REPORTING): void - reportDigitalPin(pin: number, value: Board.REPORTING): void + callback: (error?: Error, data?: number) => void): void; + setSamplingInterval(interval: number): void; + getSamplingInterval(): number; + reportAnalogPin(pin: number, value: Board.REPORTING): void; + reportDigitalPin(pin: number, value: Board.REPORTING): void; // TODO untested/incomplete --- TWW - pingRead(opts: any, callback: () => void): void + pingRead(opts: any, callback: () => void): void; stepperConfig( deviceNum: number, type: number, @@ -102,7 +102,7 @@ declare class Board extends NodeJS.EventEmitter { dirOrMotor1Pin: number, stepOrMotor2Pin: number, motor3Pin?: number, - motor4Pin?: number): void + motor4Pin?: number): void; stepperStep( deviceNum: number, direction: Board.STEPPER_DIRECTION, diff --git a/types/flatbuffers/flatbuffers-tests.ts b/types/flatbuffers/flatbuffers-tests.ts index 8c33836d3c..0edd64d75c 100644 --- a/types/flatbuffers/flatbuffers-tests.ts +++ b/types/flatbuffers/flatbuffers-tests.ts @@ -1,1458 +1,1462 @@ /** * @enum */ -export namespace MyGame.Example{ -export enum Color{ - Red= 1, - Green= 2, - Blue= 8 -}}; +export namespace MyGame.Example { + export enum Color { + Red= 1, + Green= 2, + Blue= 8 + } +} /** * @enum */ -export namespace MyGame.Example{ -export enum Any{ - NONE= 0, - Monster= 1, - TestSimpleTableWithEnum= 2, - MyGame_Example2_Monster= 3 -}}; +export namespace MyGame.Example { + export enum Any { + NONE= 0, + Monster= 1, + TestSimpleTableWithEnum= 2, + MyGame_Example2_Monster= 3 + } +} /** * @constructor */ -export namespace MyGame.Example2{ -export class Monster { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example2 { + export class Monster { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {Monster} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): Monster { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; -/** - * @param {flatbuffers.ByteBuffer} bb - * @param {Monster=} obj - * @returns {Monster} - */ -static getRootAsMonster(bb: flatbuffers.ByteBuffer, obj?: Monster): Monster { - return (obj || new Monster).__init(bb.readInt32(bb.position()) + bb.position(), bb); -}; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {Monster} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): Monster { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @param {flatbuffers.Builder} builder - */ -static startMonster(builder: flatbuffers.Builder) { - builder.startObject(0); -}; + /** + * @param {flatbuffers.ByteBuffer} bb + * @param {Monster=} obj + * @returns {Monster} + */ + static getRootAsMonster(bb: flatbuffers.ByteBuffer, obj?: Monster): Monster { + return (obj || new Monster()).__init(bb.readInt32(bb.position()) + bb.position(), bb); + } -/** - * @param {flatbuffers.Builder} builder - * @returns {flatbuffers.Offset} - */ -static endMonster(builder: flatbuffers.Builder): flatbuffers.Offset { - var offset = builder.endObject(); - return offset; -}; + /** + * @param {flatbuffers.Builder} builder + */ + static startMonster(builder: flatbuffers.Builder) { + builder.startObject(0); + } -} + /** + * @param {flatbuffers.Builder} builder + * @returns {flatbuffers.Offset} + */ + static endMonster(builder: flatbuffers.Builder): flatbuffers.Offset { + const offset = builder.endObject(); + return offset; + } + } } /** * @constructor */ -export namespace MyGame.Example{ -export class Test { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example { + export class Test { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {Test} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): Test { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; -/** - * @returns {number} - */ -a(): number { - return this.bb.readInt16(this.bb_pos); -}; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {Test} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): Test { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @param {number} value - * @returns {boolean} - */ -mutate_a(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 0); + /** + * @returns {number} + */ + a(): number { + return this.bb.readInt16(this.bb_pos); + } - if (offset === 0) { - return false; + /** + * @param {number} value + * @returns {boolean} + */ + mutate_a(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 0); + + if (offset === 0) { + return false; + } + + this.bb.writeInt16(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + b(): number { + return this.bb.readInt8(this.bb_pos + 2); + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_b(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 2); + + if (offset === 0) { + return false; + } + + this.bb.writeInt8(this.bb_pos + offset, value); + return true; + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} a + * @param {number} b + * @returns {flatbuffers.Offset} + */ + static createTest(builder: flatbuffers.Builder, a: number, b: number): flatbuffers.Offset { + builder.prep(2, 4); + builder.pad(1); + builder.writeInt8(b); + builder.writeInt16(a); + return builder.offset(); + } } - - this.bb.writeInt16(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -b(): number { - return this.bb.readInt8(this.bb_pos + 2); -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_b(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 2); - - if (offset === 0) { - return false; - } - - this.bb.writeInt8(this.bb_pos + offset, value); - return true; -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} a - * @param {number} b - * @returns {flatbuffers.Offset} - */ -static createTest(builder: flatbuffers.Builder, a: number, b: number): flatbuffers.Offset { - builder.prep(2, 4); - builder.pad(1); - builder.writeInt8(b); - builder.writeInt16(a); - return builder.offset(); -}; - -} } + /** * @constructor */ -export namespace MyGame.Example{ -export class TestSimpleTableWithEnum { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example { + export class TestSimpleTableWithEnum { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {TestSimpleTableWithEnum} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): TestSimpleTableWithEnum { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; -/** - * @param {flatbuffers.ByteBuffer} bb - * @param {TestSimpleTableWithEnum=} obj - * @returns {TestSimpleTableWithEnum} - */ -static getRootAsTestSimpleTableWithEnum(bb: flatbuffers.ByteBuffer, obj?: TestSimpleTableWithEnum): TestSimpleTableWithEnum { - return (obj || new TestSimpleTableWithEnum).__init(bb.readInt32(bb.position()) + bb.position(), bb); -}; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {TestSimpleTableWithEnum} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): TestSimpleTableWithEnum { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @returns {MyGame.Example.Color} - */ -color(): MyGame.Example.Color { - var offset = this.bb.__offset(this.bb_pos, 4); - return offset ? /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + offset)) : MyGame.Example.Color.Green; -}; + /** + * @param {flatbuffers.ByteBuffer} bb + * @param {TestSimpleTableWithEnum=} obj + * @returns {TestSimpleTableWithEnum} + */ + static getRootAsTestSimpleTableWithEnum(bb: flatbuffers.ByteBuffer, obj?: TestSimpleTableWithEnum): TestSimpleTableWithEnum { + return (obj || new TestSimpleTableWithEnum()).__init(bb.readInt32(bb.position()) + bb.position(), bb); + } -/** - * @param {MyGame.Example.Color} value - * @returns {boolean} - */ -mutate_color(value: MyGame.Example.Color): boolean { - var offset = this.bb.__offset(this.bb_pos, 4); + /** + * @returns {MyGame.Example.Color} + */ + color(): MyGame.Example.Color { + const offset = this.bb.__offset(this.bb_pos, 4); + return offset ? /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + offset)) : MyGame.Example.Color.Green; + } - if (offset === 0) { - return false; + /** + * @param {MyGame.Example.Color} value + * @returns {boolean} + */ + mutate_color(value: MyGame.Example.Color): boolean { + const offset = this.bb.__offset(this.bb_pos, 4); + + if (offset === 0) { + return false; + } + + this.bb.writeInt8(this.bb_pos + offset, value); + return true; + } + + /** + * @param {flatbuffers.Builder} builder + */ + static startTestSimpleTableWithEnum(builder: flatbuffers.Builder) { + builder.startObject(1); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {MyGame.Example.Color} color + */ + static addColor(builder: flatbuffers.Builder, color: MyGame.Example.Color) { + builder.addFieldInt8(0, color, MyGame.Example.Color.Green); + } + + /** + * @param {flatbuffers.Builder} builder + * @returns {flatbuffers.Offset} + */ + static endTestSimpleTableWithEnum(builder: flatbuffers.Builder): flatbuffers.Offset { + const offset = builder.endObject(); + return offset; + } } - - this.bb.writeInt8(this.bb_pos + offset, value); - return true; -}; - -/** - * @param {flatbuffers.Builder} builder - */ -static startTestSimpleTableWithEnum(builder: flatbuffers.Builder) { - builder.startObject(1); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {MyGame.Example.Color} color - */ -static addColor(builder: flatbuffers.Builder, color: MyGame.Example.Color) { - builder.addFieldInt8(0, color, MyGame.Example.Color.Green); -}; - -/** - * @param {flatbuffers.Builder} builder - * @returns {flatbuffers.Offset} - */ -static endTestSimpleTableWithEnum(builder: flatbuffers.Builder): flatbuffers.Offset { - var offset = builder.endObject(); - return offset; -}; - -} } + /** * @constructor */ -export namespace MyGame.Example{ -export class Vec3 { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example { + export class Vec3 { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {Vec3} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): Vec3 { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; -/** - * @returns {number} - */ -x(): number { - return this.bb.readFloat32(this.bb_pos); -}; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {Vec3} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): Vec3 { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @param {number} value - * @returns {boolean} - */ -mutate_x(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 0); + /** + * @returns {number} + */ + x(): number { + return this.bb.readFloat32(this.bb_pos); + } - if (offset === 0) { - return false; + /** + * @param {number} value + * @returns {boolean} + */ + mutate_x(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 0); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + y(): number { + return this.bb.readFloat32(this.bb_pos + 4); + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_y(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 4); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + z(): number { + return this.bb.readFloat32(this.bb_pos + 8); + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_z(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 8); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + test1(): number { + return this.bb.readFloat64(this.bb_pos + 16); + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_test1(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 16); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat64(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {MyGame.Example.Color} + */ + test2(): MyGame.Example.Color { + return /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + 24)); + } + + /** + * @param {MyGame.Example.Color} value + * @returns {boolean} + */ + mutate_test2(value: MyGame.Example.Color): boolean { + const offset = this.bb.__offset(this.bb_pos, 24); + + if (offset === 0) { + return false; + } + + this.bb.writeInt8(this.bb_pos + offset, value); + return true; + } + + /** + * @param {MyGame.Example.Test=} obj + * @returns {MyGame.Example.Test} + */ + test3(obj?: MyGame.Example.Test): MyGame.Example.Test { + return (obj || new MyGame.Example.Test()).__init(this.bb_pos + 26, this.bb); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} x + * @param {number} y + * @param {number} z + * @param {number} test1 + * @param {MyGame.Example.Color} test2 + * @param {number} test3_a + * @param {number} test3_b + * @returns {flatbuffers.Offset} + */ + static createVec3(builder: flatbuffers.Builder, x: number, y: number, z: number, test1: number, test2: MyGame.Example.Color, test3_a: number, test3_b: number): flatbuffers.Offset { + builder.prep(16, 32); + builder.pad(2); + builder.prep(2, 4); + builder.pad(1); + builder.writeInt8(test3_b); + builder.writeInt16(test3_a); + builder.pad(1); + builder.writeInt8(test2); + builder.writeFloat64(test1); + builder.pad(4); + builder.writeFloat32(z); + builder.writeFloat32(y); + builder.writeFloat32(x); + return builder.offset(); + } } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -y(): number { - return this.bb.readFloat32(this.bb_pos + 4); -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_y(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 4); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -z(): number { - return this.bb.readFloat32(this.bb_pos + 8); -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_z(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 8); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -test1(): number { - return this.bb.readFloat64(this.bb_pos + 16); -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_test1(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 16); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat64(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {MyGame.Example.Color} - */ -test2(): MyGame.Example.Color { - return /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + 24)); -}; - -/** - * @param {MyGame.Example.Color} value - * @returns {boolean} - */ -mutate_test2(value: MyGame.Example.Color): boolean { - var offset = this.bb.__offset(this.bb_pos, 24); - - if (offset === 0) { - return false; - } - - this.bb.writeInt8(this.bb_pos + offset, value); - return true; -}; - -/** - * @param {MyGame.Example.Test=} obj - * @returns {MyGame.Example.Test} - */ -test3(obj?: MyGame.Example.Test): MyGame.Example.Test { - return (obj || new MyGame.Example.Test).__init(this.bb_pos + 26, this.bb); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} x - * @param {number} y - * @param {number} z - * @param {number} test1 - * @param {MyGame.Example.Color} test2 - * @param {number} test3_a - * @param {number} test3_b - * @returns {flatbuffers.Offset} - */ -static createVec3(builder: flatbuffers.Builder, x: number, y: number, z: number, test1: number, test2: MyGame.Example.Color, test3_a: number, test3_b: number): flatbuffers.Offset { - builder.prep(16, 32); - builder.pad(2); - builder.prep(2, 4); - builder.pad(1); - builder.writeInt8(test3_b); - builder.writeInt16(test3_a); - builder.pad(1); - builder.writeInt8(test2); - builder.writeFloat64(test1); - builder.pad(4); - builder.writeFloat32(z); - builder.writeFloat32(y); - builder.writeFloat32(x); - return builder.offset(); -}; - -} } + /** * @constructor */ -export namespace MyGame.Example{ -export class Stat { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example { + export class Stat { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {Stat} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): Stat { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {Stat} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): Stat { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @param {flatbuffers.ByteBuffer} bb - * @param {Stat=} obj - * @returns {Stat} - */ -static getRootAsStat(bb: flatbuffers.ByteBuffer, obj?: Stat): Stat { - return (obj || new Stat).__init(bb.readInt32(bb.position()) + bb.position(), bb); -}; + /** + * @param {flatbuffers.ByteBuffer} bb + * @param {Stat=} obj + * @returns {Stat} + */ + static getRootAsStat(bb: flatbuffers.ByteBuffer, obj?: Stat): Stat { + return (obj || new Stat()).__init(bb.readInt32(bb.position()) + bb.position(), bb); + } -/** - * @param {flatbuffers.Encoding=} optionalEncoding - * @returns {string|Uint8Array} - */ -id(): string -id(optionalEncoding: flatbuffers.Encoding): string|Uint8Array -id(optionalEncoding?: any): string|Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 4); - return offset ? this.bb.__string(this.bb_pos + offset, optionalEncoding) : null; -}; + /** + * @param {flatbuffers.Encoding=} optionalEncoding + * @returns {string|Uint8Array} + */ + id(): string; + id(optionalEncoding: flatbuffers.Encoding): string|Uint8Array; + id(optionalEncoding?: any): string|Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 4); + return offset ? this.bb.__string(this.bb_pos + offset, optionalEncoding) : null; + } -/** - * @returns {flatbuffers.Long} - */ -val(): flatbuffers.Long { - var offset = this.bb.__offset(this.bb_pos, 6); - return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); -}; + /** + * @returns {flatbuffers.Long} + */ + val(): flatbuffers.Long { + const offset = this.bb.__offset(this.bb_pos, 6); + return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); + } -/** - * @param {flatbuffers.Long} value - * @returns {boolean} - */ -mutate_val(value: flatbuffers.Long): boolean { - var offset = this.bb.__offset(this.bb_pos, 6); + /** + * @param {flatbuffers.Long} value + * @returns {boolean} + */ + mutate_val(value: flatbuffers.Long): boolean { + const offset = this.bb.__offset(this.bb_pos, 6); - if (offset === 0) { - return false; + if (offset === 0) { + return false; + } + + this.bb.writeInt64(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + count(): number { + const offset = this.bb.__offset(this.bb_pos, 8); + return offset ? this.bb.readUint16(this.bb_pos + offset) : 0; + } + + /** + * @param {flatbuffers.Builder} builder + */ + static startStat(builder: flatbuffers.Builder) { + builder.startObject(3); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} idOffset + */ + static addId(builder: flatbuffers.Builder, idOffset: flatbuffers.Offset) { + builder.addFieldOffset(0, idOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Long} val + */ + static addVal(builder: flatbuffers.Builder, val: flatbuffers.Long) { + builder.addFieldInt64(1, val, builder.createLong(0, 0)); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} count + */ + static addCount(builder: flatbuffers.Builder, count: number) { + builder.addFieldInt16(2, count, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @returns {flatbuffers.Offset} + */ + static endStat(builder: flatbuffers.Builder): flatbuffers.Offset { + const offset = builder.endObject(); + return offset; + } } - - this.bb.writeInt64(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -count(): number { - var offset = this.bb.__offset(this.bb_pos, 8); - return offset ? this.bb.readUint16(this.bb_pos + offset) : 0; -}; - -/** - * @param {flatbuffers.Builder} builder - */ -static startStat(builder: flatbuffers.Builder) { - builder.startObject(3); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} idOffset - */ -static addId(builder: flatbuffers.Builder, idOffset: flatbuffers.Offset) { - builder.addFieldOffset(0, idOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Long} val - */ -static addVal(builder: flatbuffers.Builder, val: flatbuffers.Long) { - builder.addFieldInt64(1, val, builder.createLong(0, 0)); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} count - */ -static addCount(builder: flatbuffers.Builder, count: number) { - builder.addFieldInt16(2, count, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @returns {flatbuffers.Offset} - */ -static endStat(builder: flatbuffers.Builder): flatbuffers.Offset { - var offset = builder.endObject(); - return offset; -}; - -} } + /** * an example documentation comment: monster object * * @constructor */ -export namespace MyGame.Example{ -export class Monster { - /** - * @type {flatbuffers.ByteBuffer} - */ - bb: flatbuffers.ByteBuffer= null; +export namespace MyGame.Example { + export class Monster { + /** + * @type {flatbuffers.ByteBuffer} + */ + bb: flatbuffers.ByteBuffer= null; - /** - * @type {number} - */ - bb_pos: number = 0; -/** - * @param {number} i - * @param {flatbuffers.ByteBuffer} bb - * @returns {Monster} - */ -__init(i: number, bb: flatbuffers.ByteBuffer): Monster { - this.bb_pos = i; - this.bb = bb; - return this; -}; + /** + * @type {number} + */ + bb_pos: number = 0; + /** + * @param {number} i + * @param {flatbuffers.ByteBuffer} bb + * @returns {Monster} + */ + __init(i: number, bb: flatbuffers.ByteBuffer): Monster { + this.bb_pos = i; + this.bb = bb; + return this; + } -/** - * @param {flatbuffers.ByteBuffer} bb - * @param {Monster=} obj - * @returns {Monster} - */ -static getRootAsMonster(bb: flatbuffers.ByteBuffer, obj?: Monster): Monster { - return (obj || new Monster).__init(bb.readInt32(bb.position()) + bb.position(), bb); -}; + /** + * @param {flatbuffers.ByteBuffer} bb + * @param {Monster=} obj + * @returns {Monster} + */ + static getRootAsMonster(bb: flatbuffers.ByteBuffer, obj?: Monster): Monster { + return (obj || new Monster()).__init(bb.readInt32(bb.position()) + bb.position(), bb); + } -/** - * @param {flatbuffers.ByteBuffer} bb - * @returns {boolean} - */ -static bufferHasIdentifier(bb: flatbuffers.ByteBuffer): boolean { - return bb.__has_identifier('MONS'); -}; + /** + * @param {flatbuffers.ByteBuffer} bb + * @returns {boolean} + */ + static bufferHasIdentifier(bb: flatbuffers.ByteBuffer): boolean { + return bb.__has_identifier('MONS'); + } -/** - * @param {MyGame.Example.Vec3=} obj - * @returns {MyGame.Example.Vec3} - */ -pos(obj?: MyGame.Example.Vec3): MyGame.Example.Vec3 { - var offset = this.bb.__offset(this.bb_pos, 4); - return offset ? (obj || new MyGame.Example.Vec3).__init(this.bb_pos + offset, this.bb) : null; -}; + /** + * @param {MyGame.Example.Vec3=} obj + * @returns {MyGame.Example.Vec3} + */ + pos(obj?: MyGame.Example.Vec3): MyGame.Example.Vec3 { + const offset = this.bb.__offset(this.bb_pos, 4); + return offset ? (obj || new MyGame.Example.Vec3()).__init(this.bb_pos + offset, this.bb) : null; + } -/** - * @returns {number} - */ -mana(): number { - var offset = this.bb.__offset(this.bb_pos, 6); - return offset ? this.bb.readInt16(this.bb_pos + offset) : 150; -}; + /** + * @returns {number} + */ + mana(): number { + const offset = this.bb.__offset(this.bb_pos, 6); + return offset ? this.bb.readInt16(this.bb_pos + offset) : 150; + } -/** - * @param {number} value - * @returns {boolean} - */ -mutate_mana(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 6); + /** + * @param {number} value + * @returns {boolean} + */ + mutate_mana(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 6); - if (offset === 0) { - return false; + if (offset === 0) { + return false; + } + + this.bb.writeInt16(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + hp(): number { + const offset = this.bb.__offset(this.bb_pos, 8); + return offset ? this.bb.readInt16(this.bb_pos + offset) : 100; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_hp(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 8); + + if (offset === 0) { + return false; + } + + this.bb.writeInt16(this.bb_pos + offset, value); + return true; + } + + /** + * @param {flatbuffers.Encoding=} optionalEncoding + * @returns {string|Uint8Array} + */ + name(): string; + name(optionalEncoding: flatbuffers.Encoding): string|Uint8Array; + name(optionalEncoding?: any): string|Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 10); + return offset ? this.bb.__string(this.bb_pos + offset, optionalEncoding) : null; + } + + /** + * @param {number} index + * @returns {number} + */ + inventory(index: number): number { + const offset = this.bb.__offset(this.bb_pos, 14); + return offset ? this.bb.readUint8(this.bb.__vector(this.bb_pos + offset) + index) : 0; + } + + /** + * @returns {number} + */ + inventoryLength(): number { + const offset = this.bb.__offset(this.bb_pos, 14); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @returns {Uint8Array} + */ + inventoryArray(): Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 14); + return offset ? new Uint8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; + } + + /** + * @returns {MyGame.Example.Color} + */ + color(): MyGame.Example.Color { + const offset = this.bb.__offset(this.bb_pos, 16); + return offset ? /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + offset)) : MyGame.Example.Color.Blue; + } + + /** + * @param {MyGame.Example.Color} value + * @returns {boolean} + */ + mutate_color(value: MyGame.Example.Color): boolean { + const offset = this.bb.__offset(this.bb_pos, 16); + + if (offset === 0) { + return false; + } + + this.bb.writeInt8(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {MyGame.Example.Any} + */ + testType(): MyGame.Example.Any { + const offset = this.bb.__offset(this.bb_pos, 18); + return offset ? /** @type {MyGame.Example.Any} */ (this.bb.readUint8(this.bb_pos + offset)) : MyGame.Example.Any.NONE; + } + + /** + * @param {flatbuffers.Table} obj + * @returns {?flatbuffers.Table} + */ + test(obj: T): T { + const offset = this.bb.__offset(this.bb_pos, 20); + return offset ? this.bb.__union(obj, this.bb_pos + offset) : null; + } + + /** + * @param {number} index + * @param {MyGame.Example.Test=} obj + * @returns {MyGame.Example.Test} + */ + test4(index: number, obj?: MyGame.Example.Test): MyGame.Example.Test { + const offset = this.bb.__offset(this.bb_pos, 22); + return offset ? (obj || new MyGame.Example.Test()).__init(this.bb.__vector(this.bb_pos + offset) + index * 4, this.bb) : null; + } + + /** + * @returns {number} + */ + test4Length(): number { + const offset = this.bb.__offset(this.bb_pos, 22); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @param {number} index + * @param {flatbuffers.Encoding=} optionalEncoding + * @returns {string|Uint8Array} + */ + testarrayofstring(index: number): string; + testarrayofstring(index: number, optionalEncoding: flatbuffers.Encoding): string|Uint8Array; + testarrayofstring(index: number, optionalEncoding?: any): string|Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 24); + return offset ? this.bb.__string(this.bb.__vector(this.bb_pos + offset) + index * 4, optionalEncoding) : null; + } + + /** + * @returns {number} + */ + testarrayofstringLength(): number { + const offset = this.bb.__offset(this.bb_pos, 24); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * an example documentation comment: this will end up in the generated code + * multiline too + * + * @param {number} index + * @param {MyGame.Example.Monster=} obj + * @returns {MyGame.Example.Monster} + */ + testarrayoftables(index: number, obj?: MyGame.Example.Monster): MyGame.Example.Monster { + const offset = this.bb.__offset(this.bb_pos, 26); + return offset ? (obj || new MyGame.Example.Monster()).__init(this.bb.__indirect(this.bb.__vector(this.bb_pos + offset) + index * 4), this.bb) : null; + } + + /** + * @returns {number} + */ + testarrayoftablesLength(): number { + const offset = this.bb.__offset(this.bb_pos, 26); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @param {MyGame.Example.Monster=} obj + * @returns {MyGame.Example.Monster} + */ + enemy(obj?: MyGame.Example.Monster): MyGame.Example.Monster { + const offset = this.bb.__offset(this.bb_pos, 28); + return offset ? (obj || new MyGame.Example.Monster()).__init(this.bb.__indirect(this.bb_pos + offset), this.bb) : null; + } + + /** + * @param {number} index + * @returns {number} + */ + testnestedflatbuffer(index: number): number { + const offset = this.bb.__offset(this.bb_pos, 30); + return offset ? this.bb.readUint8(this.bb.__vector(this.bb_pos + offset) + index) : 0; + } + + /** + * @returns {number} + */ + testnestedflatbufferLength(): number { + const offset = this.bb.__offset(this.bb_pos, 30); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @returns {Uint8Array} + */ + testnestedflatbufferArray(): Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 30); + return offset ? new Uint8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; + } + + /** + * @param {MyGame.Example.Stat=} obj + * @returns {MyGame.Example.Stat} + */ + testempty(obj?: MyGame.Example.Stat): MyGame.Example.Stat { + const offset = this.bb.__offset(this.bb_pos, 32); + return offset ? (obj || new MyGame.Example.Stat()).__init(this.bb.__indirect(this.bb_pos + offset), this.bb) : null; + } + + /** + * @returns {boolean} + */ + testbool(): boolean { + const offset = this.bb.__offset(this.bb_pos, 34); + return offset ? !!this.bb.readInt8(this.bb_pos + offset) : false; + } + + /** + * @returns {number} + */ + testhashs32Fnv1(): number { + const offset = this.bb.__offset(this.bb_pos, 36); + return offset ? this.bb.readInt32(this.bb_pos + offset) : 0; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_testhashs32_fnv1(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 36); + + if (offset === 0) { + return false; + } + + this.bb.writeInt32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + testhashu32Fnv1(): number { + const offset = this.bb.__offset(this.bb_pos, 38); + return offset ? this.bb.readUint32(this.bb_pos + offset) : 0; + } + + /** + * @returns {flatbuffers.Long} + */ + testhashs64Fnv1(): flatbuffers.Long { + const offset = this.bb.__offset(this.bb_pos, 40); + return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); + } + + /** + * @param {flatbuffers.Long} value + * @returns {boolean} + */ + mutate_testhashs64_fnv1(value: flatbuffers.Long): boolean { + const offset = this.bb.__offset(this.bb_pos, 40); + + if (offset === 0) { + return false; + } + + this.bb.writeInt64(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {flatbuffers.Long} + */ + testhashu64Fnv1(): flatbuffers.Long { + const offset = this.bb.__offset(this.bb_pos, 42); + return offset ? this.bb.readUint64(this.bb_pos + offset) : this.bb.createLong(0, 0); + } + + /** + * @returns {number} + */ + testhashs32Fnv1a(): number { + const offset = this.bb.__offset(this.bb_pos, 44); + return offset ? this.bb.readInt32(this.bb_pos + offset) : 0; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_testhashs32_fnv1a(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 44); + + if (offset === 0) { + return false; + } + + this.bb.writeInt32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + testhashu32Fnv1a(): number { + const offset = this.bb.__offset(this.bb_pos, 46); + return offset ? this.bb.readUint32(this.bb_pos + offset) : 0; + } + + /** + * @returns {flatbuffers.Long} + */ + testhashs64Fnv1a(): flatbuffers.Long { + const offset = this.bb.__offset(this.bb_pos, 48); + return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); + } + + /** + * @param {flatbuffers.Long} value + * @returns {boolean} + */ + mutate_testhashs64_fnv1a(value: flatbuffers.Long): boolean { + const offset = this.bb.__offset(this.bb_pos, 48); + + if (offset === 0) { + return false; + } + + this.bb.writeInt64(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {flatbuffers.Long} + */ + testhashu64Fnv1a(): flatbuffers.Long { + const offset = this.bb.__offset(this.bb_pos, 50); + return offset ? this.bb.readUint64(this.bb_pos + offset) : this.bb.createLong(0, 0); + } + + /** + * @param {number} index + * @returns {boolean} + */ + testarrayofbools(index: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 52); + return offset ? !!this.bb.readInt8(this.bb.__vector(this.bb_pos + offset) + index) : false; + } + + /** + * @returns {number} + */ + testarrayofboolsLength(): number { + const offset = this.bb.__offset(this.bb_pos, 52); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @returns {Int8Array} + */ + testarrayofboolsArray(): Int8Array { + const offset = this.bb.__offset(this.bb_pos, 52); + return offset ? new Int8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; + } + + /** + * @returns {number} + */ + testf(): number { + const offset = this.bb.__offset(this.bb_pos, 54); + return offset ? this.bb.readFloat32(this.bb_pos + offset) : 3.14159; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_testf(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 54); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + testf2(): number { + const offset = this.bb.__offset(this.bb_pos, 56); + return offset ? this.bb.readFloat32(this.bb_pos + offset) : 3.0; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_testf2(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 56); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @returns {number} + */ + testf3(): number { + const offset = this.bb.__offset(this.bb_pos, 58); + return offset ? this.bb.readFloat32(this.bb_pos + offset) : 0.0; + } + + /** + * @param {number} value + * @returns {boolean} + */ + mutate_testf3(value: number): boolean { + const offset = this.bb.__offset(this.bb_pos, 58); + + if (offset === 0) { + return false; + } + + this.bb.writeFloat32(this.bb_pos + offset, value); + return true; + } + + /** + * @param {number} index + * @param {flatbuffers.Encoding=} optionalEncoding + * @returns {string|Uint8Array} + */ + testarrayofstring2(index: number): string; + testarrayofstring2(index: number, optionalEncoding: flatbuffers.Encoding): string|Uint8Array; + testarrayofstring2(index: number, optionalEncoding?: any): string|Uint8Array { + const offset = this.bb.__offset(this.bb_pos, 60); + return offset ? this.bb.__string(this.bb.__vector(this.bb_pos + offset) + index * 4, optionalEncoding) : null; + } + + /** + * @returns {number} + */ + testarrayofstring2Length(): number { + const offset = this.bb.__offset(this.bb_pos, 60); + return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; + } + + /** + * @param {flatbuffers.Builder} builder + */ + static startMonster(builder: flatbuffers.Builder) { + builder.startObject(29); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} posOffset + */ + static addPos(builder: flatbuffers.Builder, posOffset: flatbuffers.Offset) { + builder.addFieldStruct(0, posOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} mana + */ + static addMana(builder: flatbuffers.Builder, mana: number) { + builder.addFieldInt16(1, mana, 150); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} hp + */ + static addHp(builder: flatbuffers.Builder, hp: number) { + builder.addFieldInt16(2, hp, 100); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} nameOffset + */ + static addName(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset) { + builder.addFieldOffset(3, nameOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} inventoryOffset + */ + static addInventory(builder: flatbuffers.Builder, inventoryOffset: flatbuffers.Offset) { + builder.addFieldOffset(5, inventoryOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createInventoryVector(builder: flatbuffers.Builder, data: number[] | Uint8Array): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(1, data.length, 1); + for (let i = data.length - 1; i >= 0; i--) { + builder.addInt8(data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startInventoryVector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(1, numElems, 1); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {MyGame.Example.Color} color + */ + static addColor(builder: flatbuffers.Builder, color: MyGame.Example.Color) { + builder.addFieldInt8(6, color, MyGame.Example.Color.Blue); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {MyGame.Example.Any} testType + */ + static addTestType(builder: flatbuffers.Builder, testType: MyGame.Example.Any) { + builder.addFieldInt8(7, testType, MyGame.Example.Any.NONE); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testOffset + */ + static addTest(builder: flatbuffers.Builder, testOffset: flatbuffers.Offset) { + builder.addFieldOffset(8, testOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} test4Offset + */ + static addTest4(builder: flatbuffers.Builder, test4Offset: flatbuffers.Offset) { + builder.addFieldOffset(9, test4Offset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTest4Vector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(4, numElems, 2); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testarrayofstringOffset + */ + static addTestarrayofstring(builder: flatbuffers.Builder, testarrayofstringOffset: flatbuffers.Offset) { + builder.addFieldOffset(10, testarrayofstringOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createTestarrayofstringVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(4, data.length, 4); + for (let i = data.length - 1; i >= 0; i--) { + builder.addOffset(data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTestarrayofstringVector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(4, numElems, 4); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testarrayoftablesOffset + */ + static addTestarrayoftables(builder: flatbuffers.Builder, testarrayoftablesOffset: flatbuffers.Offset) { + builder.addFieldOffset(11, testarrayoftablesOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createTestarrayoftablesVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(4, data.length, 4); + for (let i = data.length - 1; i >= 0; i--) { + builder.addOffset(data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTestarrayoftablesVector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(4, numElems, 4); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} enemyOffset + */ + static addEnemy(builder: flatbuffers.Builder, enemyOffset: flatbuffers.Offset) { + builder.addFieldOffset(12, enemyOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testnestedflatbufferOffset + */ + static addTestnestedflatbuffer(builder: flatbuffers.Builder, testnestedflatbufferOffset: flatbuffers.Offset) { + builder.addFieldOffset(13, testnestedflatbufferOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createTestnestedflatbufferVector(builder: flatbuffers.Builder, data: number[] | Uint8Array): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(1, data.length, 1); + for (let i = data.length - 1; i >= 0; i--) { + builder.addInt8(data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTestnestedflatbufferVector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(1, numElems, 1); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testemptyOffset + */ + static addTestempty(builder: flatbuffers.Builder, testemptyOffset: flatbuffers.Offset) { + builder.addFieldOffset(14, testemptyOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {boolean} testbool + */ + static addTestbool(builder: flatbuffers.Builder, testbool: boolean) { + builder.addFieldInt8(15, +testbool, +false); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testhashs32Fnv1 + */ + static addTesthashs32Fnv1(builder: flatbuffers.Builder, testhashs32Fnv1: number) { + builder.addFieldInt32(16, testhashs32Fnv1, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testhashu32Fnv1 + */ + static addTesthashu32Fnv1(builder: flatbuffers.Builder, testhashu32Fnv1: number) { + builder.addFieldInt32(17, testhashu32Fnv1, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Long} testhashs64Fnv1 + */ + static addTesthashs64Fnv1(builder: flatbuffers.Builder, testhashs64Fnv1: flatbuffers.Long) { + builder.addFieldInt64(18, testhashs64Fnv1, builder.createLong(0, 0)); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Long} testhashu64Fnv1 + */ + static addTesthashu64Fnv1(builder: flatbuffers.Builder, testhashu64Fnv1: flatbuffers.Long) { + builder.addFieldInt64(19, testhashu64Fnv1, builder.createLong(0, 0)); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testhashs32Fnv1a + */ + static addTesthashs32Fnv1a(builder: flatbuffers.Builder, testhashs32Fnv1a: number) { + builder.addFieldInt32(20, testhashs32Fnv1a, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testhashu32Fnv1a + */ + static addTesthashu32Fnv1a(builder: flatbuffers.Builder, testhashu32Fnv1a: number) { + builder.addFieldInt32(21, testhashu32Fnv1a, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Long} testhashs64Fnv1a + */ + static addTesthashs64Fnv1a(builder: flatbuffers.Builder, testhashs64Fnv1a: flatbuffers.Long) { + builder.addFieldInt64(22, testhashs64Fnv1a, builder.createLong(0, 0)); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Long} testhashu64Fnv1a + */ + static addTesthashu64Fnv1a(builder: flatbuffers.Builder, testhashu64Fnv1a: flatbuffers.Long) { + builder.addFieldInt64(23, testhashu64Fnv1a, builder.createLong(0, 0)); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testarrayofboolsOffset + */ + static addTestarrayofbools(builder: flatbuffers.Builder, testarrayofboolsOffset: flatbuffers.Offset) { + builder.addFieldOffset(24, testarrayofboolsOffset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createTestarrayofboolsVector(builder: flatbuffers.Builder, data: boolean[]): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(1, data.length, 1); + for (let i = data.length - 1; i >= 0; i--) { + builder.addInt8(+data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTestarrayofboolsVector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(1, numElems, 1); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testf + */ + static addTestf(builder: flatbuffers.Builder, testf: number) { + builder.addFieldFloat32(25, testf, 3.14159); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testf2 + */ + static addTestf2(builder: flatbuffers.Builder, testf2: number) { + builder.addFieldFloat32(26, testf2, 3.0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} testf3 + */ + static addTestf3(builder: flatbuffers.Builder, testf3: number) { + builder.addFieldFloat32(27, testf3, 0.0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} testarrayofstring2Offset + */ + static addTestarrayofstring2(builder: flatbuffers.Builder, testarrayofstring2Offset: flatbuffers.Offset) { + builder.addFieldOffset(28, testarrayofstring2Offset, 0); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {Array.} data + * @returns {flatbuffers.Offset} + */ + static createTestarrayofstring2Vector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { + if (!data) { + return null; + } + builder.startVector(4, data.length, 4); + for (let i = data.length - 1; i >= 0; i--) { + builder.addOffset(data[i]); + } + return builder.endVector(); + } + + /** + * @param {flatbuffers.Builder} builder + * @param {number} numElems + */ + static startTestarrayofstring2Vector(builder: flatbuffers.Builder, numElems: number) { + builder.startVector(4, numElems, 4); + } + + /** + * @param {flatbuffers.Builder} builder + * @returns {flatbuffers.Offset} + */ + static endMonster(builder: flatbuffers.Builder): flatbuffers.Offset { + const offset = builder.endObject(); + builder.requiredField(offset, 10); // name + return offset; + } + + /** + * @param {flatbuffers.Builder} builder + * @param {flatbuffers.Offset} offset + */ + static finishMonsterBuffer(builder: flatbuffers.Builder, offset: flatbuffers.Offset) { + builder.finish(offset, 'MONS'); + } } - - this.bb.writeInt16(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -hp(): number { - var offset = this.bb.__offset(this.bb_pos, 8); - return offset ? this.bb.readInt16(this.bb_pos + offset) : 100; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_hp(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 8); - - if (offset === 0) { - return false; - } - - this.bb.writeInt16(this.bb_pos + offset, value); - return true; -}; - -/** - * @param {flatbuffers.Encoding=} optionalEncoding - * @returns {string|Uint8Array} - */ -name(): string -name(optionalEncoding: flatbuffers.Encoding): string|Uint8Array -name(optionalEncoding?: any): string|Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 10); - return offset ? this.bb.__string(this.bb_pos + offset, optionalEncoding) : null; -}; - -/** - * @param {number} index - * @returns {number} - */ -inventory(index: number): number { - var offset = this.bb.__offset(this.bb_pos, 14); - return offset ? this.bb.readUint8(this.bb.__vector(this.bb_pos + offset) + index) : 0; -}; - -/** - * @returns {number} - */ -inventoryLength(): number { - var offset = this.bb.__offset(this.bb_pos, 14); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @returns {Uint8Array} - */ -inventoryArray(): Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 14); - return offset ? new Uint8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; -}; - -/** - * @returns {MyGame.Example.Color} - */ -color(): MyGame.Example.Color { - var offset = this.bb.__offset(this.bb_pos, 16); - return offset ? /** @type {MyGame.Example.Color} */ (this.bb.readInt8(this.bb_pos + offset)) : MyGame.Example.Color.Blue; -}; - -/** - * @param {MyGame.Example.Color} value - * @returns {boolean} - */ -mutate_color(value: MyGame.Example.Color): boolean { - var offset = this.bb.__offset(this.bb_pos, 16); - - if (offset === 0) { - return false; - } - - this.bb.writeInt8(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {MyGame.Example.Any} - */ -testType(): MyGame.Example.Any { - var offset = this.bb.__offset(this.bb_pos, 18); - return offset ? /** @type {MyGame.Example.Any} */ (this.bb.readUint8(this.bb_pos + offset)) : MyGame.Example.Any.NONE; -}; - -/** - * @param {flatbuffers.Table} obj - * @returns {?flatbuffers.Table} - */ -test(obj: T): T { - var offset = this.bb.__offset(this.bb_pos, 20); - return offset ? this.bb.__union(obj, this.bb_pos + offset) : null; -}; - -/** - * @param {number} index - * @param {MyGame.Example.Test=} obj - * @returns {MyGame.Example.Test} - */ -test4(index: number, obj?: MyGame.Example.Test): MyGame.Example.Test { - var offset = this.bb.__offset(this.bb_pos, 22); - return offset ? (obj || new MyGame.Example.Test).__init(this.bb.__vector(this.bb_pos + offset) + index * 4, this.bb) : null; -}; - -/** - * @returns {number} - */ -test4Length(): number { - var offset = this.bb.__offset(this.bb_pos, 22); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @param {number} index - * @param {flatbuffers.Encoding=} optionalEncoding - * @returns {string|Uint8Array} - */ -testarrayofstring(index: number): string -testarrayofstring(index: number, optionalEncoding: flatbuffers.Encoding): string|Uint8Array -testarrayofstring(index: number, optionalEncoding?: any): string|Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 24); - return offset ? this.bb.__string(this.bb.__vector(this.bb_pos + offset) + index * 4, optionalEncoding) : null; -}; - -/** - * @returns {number} - */ -testarrayofstringLength(): number { - var offset = this.bb.__offset(this.bb_pos, 24); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * an example documentation comment: this will end up in the generated code - * multiline too - * - * @param {number} index - * @param {MyGame.Example.Monster=} obj - * @returns {MyGame.Example.Monster} - */ -testarrayoftables(index: number, obj?: MyGame.Example.Monster): MyGame.Example.Monster { - var offset = this.bb.__offset(this.bb_pos, 26); - return offset ? (obj || new MyGame.Example.Monster).__init(this.bb.__indirect(this.bb.__vector(this.bb_pos + offset) + index * 4), this.bb) : null; -}; - -/** - * @returns {number} - */ -testarrayoftablesLength(): number { - var offset = this.bb.__offset(this.bb_pos, 26); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @param {MyGame.Example.Monster=} obj - * @returns {MyGame.Example.Monster} - */ -enemy(obj?: MyGame.Example.Monster): MyGame.Example.Monster { - var offset = this.bb.__offset(this.bb_pos, 28); - return offset ? (obj || new MyGame.Example.Monster).__init(this.bb.__indirect(this.bb_pos + offset), this.bb) : null; -}; - -/** - * @param {number} index - * @returns {number} - */ -testnestedflatbuffer(index: number): number { - var offset = this.bb.__offset(this.bb_pos, 30); - return offset ? this.bb.readUint8(this.bb.__vector(this.bb_pos + offset) + index) : 0; -}; - -/** - * @returns {number} - */ -testnestedflatbufferLength(): number { - var offset = this.bb.__offset(this.bb_pos, 30); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @returns {Uint8Array} - */ -testnestedflatbufferArray(): Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 30); - return offset ? new Uint8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; -}; - -/** - * @param {MyGame.Example.Stat=} obj - * @returns {MyGame.Example.Stat} - */ -testempty(obj?: MyGame.Example.Stat): MyGame.Example.Stat { - var offset = this.bb.__offset(this.bb_pos, 32); - return offset ? (obj || new MyGame.Example.Stat).__init(this.bb.__indirect(this.bb_pos + offset), this.bb) : null; -}; - -/** - * @returns {boolean} - */ -testbool(): boolean { - var offset = this.bb.__offset(this.bb_pos, 34); - return offset ? !!this.bb.readInt8(this.bb_pos + offset) : false; -}; - -/** - * @returns {number} - */ -testhashs32Fnv1(): number { - var offset = this.bb.__offset(this.bb_pos, 36); - return offset ? this.bb.readInt32(this.bb_pos + offset) : 0; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_testhashs32_fnv1(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 36); - - if (offset === 0) { - return false; - } - - this.bb.writeInt32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -testhashu32Fnv1(): number { - var offset = this.bb.__offset(this.bb_pos, 38); - return offset ? this.bb.readUint32(this.bb_pos + offset) : 0; -}; - -/** - * @returns {flatbuffers.Long} - */ -testhashs64Fnv1(): flatbuffers.Long { - var offset = this.bb.__offset(this.bb_pos, 40); - return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); -}; - -/** - * @param {flatbuffers.Long} value - * @returns {boolean} - */ -mutate_testhashs64_fnv1(value: flatbuffers.Long): boolean { - var offset = this.bb.__offset(this.bb_pos, 40); - - if (offset === 0) { - return false; - } - - this.bb.writeInt64(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {flatbuffers.Long} - */ -testhashu64Fnv1(): flatbuffers.Long { - var offset = this.bb.__offset(this.bb_pos, 42); - return offset ? this.bb.readUint64(this.bb_pos + offset) : this.bb.createLong(0, 0); -}; - -/** - * @returns {number} - */ -testhashs32Fnv1a(): number { - var offset = this.bb.__offset(this.bb_pos, 44); - return offset ? this.bb.readInt32(this.bb_pos + offset) : 0; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_testhashs32_fnv1a(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 44); - - if (offset === 0) { - return false; - } - - this.bb.writeInt32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -testhashu32Fnv1a(): number { - var offset = this.bb.__offset(this.bb_pos, 46); - return offset ? this.bb.readUint32(this.bb_pos + offset) : 0; -}; - -/** - * @returns {flatbuffers.Long} - */ -testhashs64Fnv1a(): flatbuffers.Long { - var offset = this.bb.__offset(this.bb_pos, 48); - return offset ? this.bb.readInt64(this.bb_pos + offset) : this.bb.createLong(0, 0); -}; - -/** - * @param {flatbuffers.Long} value - * @returns {boolean} - */ -mutate_testhashs64_fnv1a(value: flatbuffers.Long): boolean { - var offset = this.bb.__offset(this.bb_pos, 48); - - if (offset === 0) { - return false; - } - - this.bb.writeInt64(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {flatbuffers.Long} - */ -testhashu64Fnv1a(): flatbuffers.Long { - var offset = this.bb.__offset(this.bb_pos, 50); - return offset ? this.bb.readUint64(this.bb_pos + offset) : this.bb.createLong(0, 0); -}; - -/** - * @param {number} index - * @returns {boolean} - */ -testarrayofbools(index: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 52); - return offset ? !!this.bb.readInt8(this.bb.__vector(this.bb_pos + offset) + index) : false; -}; - -/** - * @returns {number} - */ -testarrayofboolsLength(): number { - var offset = this.bb.__offset(this.bb_pos, 52); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @returns {Int8Array} - */ -testarrayofboolsArray(): Int8Array { - var offset = this.bb.__offset(this.bb_pos, 52); - return offset ? new Int8Array(this.bb.bytes().buffer, this.bb.bytes().byteOffset + this.bb.__vector(this.bb_pos + offset), this.bb.__vector_len(this.bb_pos + offset)) : null; -}; - -/** - * @returns {number} - */ -testf(): number { - var offset = this.bb.__offset(this.bb_pos, 54); - return offset ? this.bb.readFloat32(this.bb_pos + offset) : 3.14159; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_testf(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 54); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -testf2(): number { - var offset = this.bb.__offset(this.bb_pos, 56); - return offset ? this.bb.readFloat32(this.bb_pos + offset) : 3.0; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_testf2(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 56); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @returns {number} - */ -testf3(): number { - var offset = this.bb.__offset(this.bb_pos, 58); - return offset ? this.bb.readFloat32(this.bb_pos + offset) : 0.0; -}; - -/** - * @param {number} value - * @returns {boolean} - */ -mutate_testf3(value: number): boolean { - var offset = this.bb.__offset(this.bb_pos, 58); - - if (offset === 0) { - return false; - } - - this.bb.writeFloat32(this.bb_pos + offset, value); - return true; -}; - -/** - * @param {number} index - * @param {flatbuffers.Encoding=} optionalEncoding - * @returns {string|Uint8Array} - */ -testarrayofstring2(index: number): string -testarrayofstring2(index: number, optionalEncoding: flatbuffers.Encoding): string|Uint8Array -testarrayofstring2(index: number, optionalEncoding?: any): string|Uint8Array { - var offset = this.bb.__offset(this.bb_pos, 60); - return offset ? this.bb.__string(this.bb.__vector(this.bb_pos + offset) + index * 4, optionalEncoding) : null; -}; - -/** - * @returns {number} - */ -testarrayofstring2Length(): number { - var offset = this.bb.__offset(this.bb_pos, 60); - return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0; -}; - -/** - * @param {flatbuffers.Builder} builder - */ -static startMonster(builder: flatbuffers.Builder) { - builder.startObject(29); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} posOffset - */ -static addPos(builder: flatbuffers.Builder, posOffset: flatbuffers.Offset) { - builder.addFieldStruct(0, posOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} mana - */ -static addMana(builder: flatbuffers.Builder, mana: number) { - builder.addFieldInt16(1, mana, 150); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} hp - */ -static addHp(builder: flatbuffers.Builder, hp: number) { - builder.addFieldInt16(2, hp, 100); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} nameOffset - */ -static addName(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset) { - builder.addFieldOffset(3, nameOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} inventoryOffset - */ -static addInventory(builder: flatbuffers.Builder, inventoryOffset: flatbuffers.Offset) { - builder.addFieldOffset(5, inventoryOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createInventoryVector(builder: flatbuffers.Builder, data: number[] | Uint8Array): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(1, data.length, 1); - for (var i = data.length - 1; i >= 0; i--) { - builder.addInt8(data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startInventoryVector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(1, numElems, 1); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {MyGame.Example.Color} color - */ -static addColor(builder: flatbuffers.Builder, color: MyGame.Example.Color) { - builder.addFieldInt8(6, color, MyGame.Example.Color.Blue); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {MyGame.Example.Any} testType - */ -static addTestType(builder: flatbuffers.Builder, testType: MyGame.Example.Any) { - builder.addFieldInt8(7, testType, MyGame.Example.Any.NONE); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testOffset - */ -static addTest(builder: flatbuffers.Builder, testOffset: flatbuffers.Offset) { - builder.addFieldOffset(8, testOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} test4Offset - */ -static addTest4(builder: flatbuffers.Builder, test4Offset: flatbuffers.Offset) { - builder.addFieldOffset(9, test4Offset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTest4Vector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(4, numElems, 2); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testarrayofstringOffset - */ -static addTestarrayofstring(builder: flatbuffers.Builder, testarrayofstringOffset: flatbuffers.Offset) { - builder.addFieldOffset(10, testarrayofstringOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createTestarrayofstringVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(4, data.length, 4); - for (var i = data.length - 1; i >= 0; i--) { - builder.addOffset(data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTestarrayofstringVector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(4, numElems, 4); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testarrayoftablesOffset - */ -static addTestarrayoftables(builder: flatbuffers.Builder, testarrayoftablesOffset: flatbuffers.Offset) { - builder.addFieldOffset(11, testarrayoftablesOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createTestarrayoftablesVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(4, data.length, 4); - for (var i = data.length - 1; i >= 0; i--) { - builder.addOffset(data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTestarrayoftablesVector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(4, numElems, 4); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} enemyOffset - */ -static addEnemy(builder: flatbuffers.Builder, enemyOffset: flatbuffers.Offset) { - builder.addFieldOffset(12, enemyOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testnestedflatbufferOffset - */ -static addTestnestedflatbuffer(builder: flatbuffers.Builder, testnestedflatbufferOffset: flatbuffers.Offset) { - builder.addFieldOffset(13, testnestedflatbufferOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createTestnestedflatbufferVector(builder: flatbuffers.Builder, data: number[] | Uint8Array): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(1, data.length, 1); - for (var i = data.length - 1; i >= 0; i--) { - builder.addInt8(data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTestnestedflatbufferVector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(1, numElems, 1); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testemptyOffset - */ -static addTestempty(builder: flatbuffers.Builder, testemptyOffset: flatbuffers.Offset) { - builder.addFieldOffset(14, testemptyOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {boolean} testbool - */ -static addTestbool(builder: flatbuffers.Builder, testbool: boolean) { - builder.addFieldInt8(15, +testbool, +false); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testhashs32Fnv1 - */ -static addTesthashs32Fnv1(builder: flatbuffers.Builder, testhashs32Fnv1: number) { - builder.addFieldInt32(16, testhashs32Fnv1, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testhashu32Fnv1 - */ -static addTesthashu32Fnv1(builder: flatbuffers.Builder, testhashu32Fnv1: number) { - builder.addFieldInt32(17, testhashu32Fnv1, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Long} testhashs64Fnv1 - */ -static addTesthashs64Fnv1(builder: flatbuffers.Builder, testhashs64Fnv1: flatbuffers.Long) { - builder.addFieldInt64(18, testhashs64Fnv1, builder.createLong(0, 0)); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Long} testhashu64Fnv1 - */ -static addTesthashu64Fnv1(builder: flatbuffers.Builder, testhashu64Fnv1: flatbuffers.Long) { - builder.addFieldInt64(19, testhashu64Fnv1, builder.createLong(0, 0)); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testhashs32Fnv1a - */ -static addTesthashs32Fnv1a(builder: flatbuffers.Builder, testhashs32Fnv1a: number) { - builder.addFieldInt32(20, testhashs32Fnv1a, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testhashu32Fnv1a - */ -static addTesthashu32Fnv1a(builder: flatbuffers.Builder, testhashu32Fnv1a: number) { - builder.addFieldInt32(21, testhashu32Fnv1a, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Long} testhashs64Fnv1a - */ -static addTesthashs64Fnv1a(builder: flatbuffers.Builder, testhashs64Fnv1a: flatbuffers.Long) { - builder.addFieldInt64(22, testhashs64Fnv1a, builder.createLong(0, 0)); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Long} testhashu64Fnv1a - */ -static addTesthashu64Fnv1a(builder: flatbuffers.Builder, testhashu64Fnv1a: flatbuffers.Long) { - builder.addFieldInt64(23, testhashu64Fnv1a, builder.createLong(0, 0)); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testarrayofboolsOffset - */ -static addTestarrayofbools(builder: flatbuffers.Builder, testarrayofboolsOffset: flatbuffers.Offset) { - builder.addFieldOffset(24, testarrayofboolsOffset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createTestarrayofboolsVector(builder: flatbuffers.Builder, data: boolean[]): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(1, data.length, 1); - for (var i = data.length - 1; i >= 0; i--) { - builder.addInt8(+data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTestarrayofboolsVector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(1, numElems, 1); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testf - */ -static addTestf(builder: flatbuffers.Builder, testf: number) { - builder.addFieldFloat32(25, testf, 3.14159); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testf2 - */ -static addTestf2(builder: flatbuffers.Builder, testf2: number) { - builder.addFieldFloat32(26, testf2, 3.0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} testf3 - */ -static addTestf3(builder: flatbuffers.Builder, testf3: number) { - builder.addFieldFloat32(27, testf3, 0.0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} testarrayofstring2Offset - */ -static addTestarrayofstring2(builder: flatbuffers.Builder, testarrayofstring2Offset: flatbuffers.Offset) { - builder.addFieldOffset(28, testarrayofstring2Offset, 0); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {Array.} data - * @returns {flatbuffers.Offset} - */ -static createTestarrayofstring2Vector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset { -if (!data){ - return null -} - builder.startVector(4, data.length, 4); - for (var i = data.length - 1; i >= 0; i--) { - builder.addOffset(data[i]); - } - return builder.endVector(); -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {number} numElems - */ -static startTestarrayofstring2Vector(builder: flatbuffers.Builder, numElems: number) { - builder.startVector(4, numElems, 4); -}; - -/** - * @param {flatbuffers.Builder} builder - * @returns {flatbuffers.Offset} - */ -static endMonster(builder: flatbuffers.Builder): flatbuffers.Offset { - var offset = builder.endObject(); - builder.requiredField(offset, 10); // name - return offset; -}; - -/** - * @param {flatbuffers.Builder} builder - * @param {flatbuffers.Offset} offset - */ -static finishMonsterBuffer(builder: flatbuffers.Builder, offset: flatbuffers.Offset) { - builder.finish(offset, 'MONS'); -}; - -} } diff --git a/types/flatbuffers/index.d.ts b/types/flatbuffers/index.d.ts index 71e56ed188..e813ab461b 100644 --- a/types/flatbuffers/index.d.ts +++ b/types/flatbuffers/index.d.ts @@ -4,11 +4,10 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace flatbuffers { - /** * @typedef {number} */ - export type Offset = number; + type Offset = number; /** * @typedef {{ @@ -16,7 +15,7 @@ declare namespace flatbuffers { * bb_pos: number * }} */ - export interface Table { + interface Table { bb: ByteBuffer; bb_pos: number; } @@ -25,53 +24,52 @@ declare namespace flatbuffers { * @type {number} * @const */ - export const SIZEOF_SHORT: number; + const SIZEOF_SHORT: number; /** * @type {number} * @const */ - export const SIZEOF_INT: number; + const SIZEOF_INT: number; /** * @type {number} * @const */ - export const FILE_IDENTIFIER_LENGTH: number; + const FILE_IDENTIFIER_LENGTH: number; /** * @enum {number} */ - export enum Encoding { UTF8_BYTES, UTF16_STRING } + enum Encoding { UTF8_BYTES, UTF16_STRING } /** * @type {Int32Array} * @const */ - export var int32: Int32Array; + const int32: Int32Array; /** * @type {Float32Array} * @const */ - export var float32: Float32Array; + const float32: Float32Array; /** * @type {Float64Array} * @const */ - export var float64: Float64Array; + const float64: Float64Array; /** * @type {boolean} * @const */ - export var isLittleEndian: boolean; + const isLittleEndian: boolean; //////////////////////////////////////////////////////////////////////////////// - export class Long { - + class Long { /** * @type {number} * @const @@ -110,16 +108,14 @@ declare namespace flatbuffers { /** * @param {number} low - * @param {number} high + * @param {number} high */ static create(low: number, high: number): Long; } - //////////////////////////////////////////////////////////////////////////////// - export class Builder { - + class Builder { /** * @constructor * @param {number=} initial_size @@ -393,19 +389,17 @@ declare namespace flatbuffers { /** * Conveniance function for creating Long objects. - * - * @param {number} low - * @param {number} high + * + * @param {number} low + * @param {number} high * @returns {Long} */ createLong(low: number, high: number): Long; } //////////////////////////////////////////////////////////////////////////////// - class ByteBuffer { - /** * @constructor * @param {Uint8Array} bytes @@ -599,12 +593,11 @@ declare namespace flatbuffers { /** * Conveniance function for creating Long objects. - * - * @param {number} low - * @param {number} high + * + * @param {number} low + * @param {number} high * @returns {Long} */ createLong(low: number, high: number): Long; } - } diff --git a/types/flatbuffers/tslint.json b/types/flatbuffers/tslint.json index 2221e40e4a..6a3ea07434 100644 --- a/types/flatbuffers/tslint.json +++ b/types/flatbuffers/tslint.json @@ -1 +1,6 @@ -{ "extends": "../tslint.json" } \ No newline at end of file +{ + "extends": "../tslint.json", + "rules": { + "align": false + } +} \ No newline at end of file diff --git a/types/flatpickr/index.d.ts b/types/flatpickr/index.d.ts index fc3de85a53..9a98beabaa 100644 --- a/types/flatpickr/index.d.ts +++ b/types/flatpickr/index.d.ts @@ -49,7 +49,7 @@ declare namespace Flatpickr { onYearChange?: EventCallback | EventCallback[]; onValueUpdate?: EventCallback | EventCallback[]; onDayCreate?: EventCallback | EventCallback[]; - parseDate?: (date: string) => Date; + parseDate?(date: string): Date; prevArrow?: string; shorthandCurrentMonth?: boolean; static?: boolean; diff --git a/types/forever-monitor/index.d.ts b/types/forever-monitor/index.d.ts index 22fa4b0c61..cd5869f6d3 100644 --- a/types/forever-monitor/index.d.ts +++ b/types/forever-monitor/index.d.ts @@ -32,7 +32,7 @@ export interface Options { logFile?: string; outFile?: string; errFile?: string; - parser?: (command: string, args: string[]) => { command: string, args: string[] }; + parser?(command: string, args: string[]): { command: string, args: string[] }; } export function start(script: string, options?: Options): Monitor; @@ -41,7 +41,6 @@ export function checkProcess(pid: number): boolean; export const version: string; export class Monitor extends NodeJS.EventEmitter { - /** * @param script - Location of the target script to run. * @param [options] - Configuration for this instance. diff --git a/types/format-unicorn/test/index.ts b/types/format-unicorn/test/index.ts index 101c0cc143..904898b433 100644 --- a/types/format-unicorn/test/index.ts +++ b/types/format-unicorn/test/index.ts @@ -1,7 +1,7 @@ import 'format-unicorn'; // Unsafe version -var outputString: string; +let outputString: string; outputString = 'Hello, {name}; you have {favoriteNumber}'.formatUnicorn({ name: "kruncher", diff --git a/types/format-unicorn/test/safe.ts b/types/format-unicorn/test/safe.ts index 12e325fc36..9eec85d714 100644 --- a/types/format-unicorn/test/safe.ts +++ b/types/format-unicorn/test/safe.ts @@ -1,7 +1,7 @@ import formatUnicorn = require('format-unicorn/safe'); // Safe version -var outputString: string; +let outputString: string; outputString = formatUnicorn('Hello, {name}; you have {favoriteNumber}', { name: "kruncher", diff --git a/types/freeport/freeport-tests.ts b/types/freeport/freeport-tests.ts index 2746aeb4ed..35fdb19f2b 100644 --- a/types/freeport/freeport-tests.ts +++ b/types/freeport/freeport-tests.ts @@ -1,7 +1,7 @@ import freeport = require('freeport'); -let num: number, - error: Error; +let num: number; +let error: Error; freeport((err, made) => { error = err; diff --git a/types/fullcalendar/index.d.ts b/types/fullcalendar/index.d.ts index 76a5de13f3..02b30832b1 100644 --- a/types/fullcalendar/index.d.ts +++ b/types/fullcalendar/index.d.ts @@ -102,7 +102,7 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr * * - EventObject[] * - string (JSON feed) - * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; + * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; */ events?: any; @@ -112,7 +112,7 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr * - EventSource * - EventObject[] * - string (JSON feed) - * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; + * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; */ eventSources?: any[]; @@ -145,7 +145,7 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr } /** - * Agenda Options - http://fullcalendar.io/docs/agenda/ + * Agenda Options - http://fullcalendar.io/docs/agenda/ */ export interface AgendaOptions { allDaySlot?: boolean; @@ -244,7 +244,7 @@ export interface EventSource extends JQueryAjaxSettings { * * - EventObject[] * - string (JSON feed) - * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; + * - (start: moment.Moment, end: moment.Moment, timezone: string | boolean, callback: {(events: EventObject[]) => void;}) => void; */ events?: any; diff --git a/types/fusioncharts/fusioncharts.charts.d.ts b/types/fusioncharts/fusioncharts.charts.d.ts index 82a41f7333..bab32b04b8 100644 --- a/types/fusioncharts/fusioncharts.charts.d.ts +++ b/types/fusioncharts/fusioncharts.charts.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var charts: (H: FusionChartStatic) => FusionChartStatic; +declare function charts(H: FusionChartStatic): FusionChartStatic; export = charts; export as namespace charts; diff --git a/types/fusioncharts/fusioncharts.gantt.d.ts b/types/fusioncharts/fusioncharts.gantt.d.ts index e9dd4cfccf..847aa93707 100644 --- a/types/fusioncharts/fusioncharts.gantt.d.ts +++ b/types/fusioncharts/fusioncharts.gantt.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var gantt: (H: FusionChartStatic) => FusionChartStatic; +declare function gantt(H: FusionChartStatic): FusionChartStatic; export = gantt; export as namespace gantt; diff --git a/types/fusioncharts/fusioncharts.maps.d.ts b/types/fusioncharts/fusioncharts.maps.d.ts index 48c5869608..ea5ed5922d 100644 --- a/types/fusioncharts/fusioncharts.maps.d.ts +++ b/types/fusioncharts/fusioncharts.maps.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var maps: (H: FusionChartStatic) => FusionChartStatic; +declare function maps(H: FusionChartStatic): FusionChartStatic; export = maps; export as namespace maps; diff --git a/types/fusioncharts/fusioncharts.powercharts.d.ts b/types/fusioncharts/fusioncharts.powercharts.d.ts index e2004e8423..b854d2ce64 100644 --- a/types/fusioncharts/fusioncharts.powercharts.d.ts +++ b/types/fusioncharts/fusioncharts.powercharts.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var powercharts: (H: FusionChartStatic) => FusionChartStatic; +declare function powercharts(H: FusionChartStatic): FusionChartStatic; export = powercharts; export as namespace powercharts; diff --git a/types/fusioncharts/fusioncharts.ssgrid.d.ts b/types/fusioncharts/fusioncharts.ssgrid.d.ts index fb7c2d51a2..88e8c02afb 100644 --- a/types/fusioncharts/fusioncharts.ssgrid.d.ts +++ b/types/fusioncharts/fusioncharts.ssgrid.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var ssgrid: (H: FusionChartStatic) => FusionChartStatic; +declare function ssgrid(H: FusionChartStatic): FusionChartStatic; export = ssgrid; export as namespace ssgrid; diff --git a/types/fusioncharts/fusioncharts.treemap.d.ts b/types/fusioncharts/fusioncharts.treemap.d.ts index 146c8b8b54..9ca8941e62 100644 --- a/types/fusioncharts/fusioncharts.treemap.d.ts +++ b/types/fusioncharts/fusioncharts.treemap.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var treemap: (H: FusionChartStatic) => FusionChartStatic; +declare function treemap(H: FusionChartStatic): FusionChartStatic; export = treemap; export as namespace treemap; diff --git a/types/fusioncharts/fusioncharts.widgets.d.ts b/types/fusioncharts/fusioncharts.widgets.d.ts index ea16eb60c9..719e791409 100644 --- a/types/fusioncharts/fusioncharts.widgets.d.ts +++ b/types/fusioncharts/fusioncharts.widgets.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var widgets: (H: FusionChartStatic) => FusionChartStatic; +declare function widgets(H: FusionChartStatic): FusionChartStatic; export = widgets; export as namespace widgets; diff --git a/types/fusioncharts/fusioncharts.zoomscatter.d.ts b/types/fusioncharts/fusioncharts.zoomscatter.d.ts index 277050a77a..4e6a53a364 100644 --- a/types/fusioncharts/fusioncharts.zoomscatter.d.ts +++ b/types/fusioncharts/fusioncharts.zoomscatter.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var zoomscatter: (H: FusionChartStatic) => FusionChartStatic; +declare function zoomscatter(H: FusionChartStatic): FusionChartStatic; export = zoomscatter; export as namespace zoomscatter; diff --git a/types/fusioncharts/index.d.ts b/types/fusioncharts/index.d.ts index e218e32cd5..6f24d3b223 100644 --- a/types/fusioncharts/index.d.ts +++ b/types/fusioncharts/index.d.ts @@ -19,15 +19,15 @@ declare namespace FusionCharts { cancelled: boolean; - stopPropagation: () => void; + stopPropagation(): void; prevented: boolean; - preventDefault: () => void; + preventDefault(): void; detached: boolean; - detachHandler: () => void; + detachHandler(): void; } interface ChartObject { diff --git a/types/fusioncharts/maps/fusioncharts.usa.d.ts b/types/fusioncharts/maps/fusioncharts.usa.d.ts index 5b02b82aa8..ce03434417 100644 --- a/types/fusioncharts/maps/fusioncharts.usa.d.ts +++ b/types/fusioncharts/maps/fusioncharts.usa.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var usa: (H: FusionChartStatic) => FusionChartStatic; +declare function usa(H: FusionChartStatic): FusionChartStatic; export = usa; export as namespace usa; diff --git a/types/fusioncharts/maps/fusioncharts.world.d.ts b/types/fusioncharts/maps/fusioncharts.world.d.ts index e950cc08e3..8d68a0e03f 100644 --- a/types/fusioncharts/maps/fusioncharts.world.d.ts +++ b/types/fusioncharts/maps/fusioncharts.world.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var world: (H: FusionChartStatic) => FusionChartStatic; +declare function world(H: FusionChartStatic): FusionChartStatic; export = world; export as namespace world; diff --git a/types/fusioncharts/themes/fusioncharts.theme.carbon.d.ts b/types/fusioncharts/themes/fusioncharts.theme.carbon.d.ts index 80b8096801..833c371ee4 100644 --- a/types/fusioncharts/themes/fusioncharts.theme.carbon.d.ts +++ b/types/fusioncharts/themes/fusioncharts.theme.carbon.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var carbon: (H: FusionChartStatic) => FusionChartStatic; +declare function carbon(H: FusionChartStatic): FusionChartStatic; export = carbon; export as namespace carbon; diff --git a/types/fusioncharts/themes/fusioncharts.theme.fint.d.ts b/types/fusioncharts/themes/fusioncharts.theme.fint.d.ts index a72265a049..fc9017e342 100644 --- a/types/fusioncharts/themes/fusioncharts.theme.fint.d.ts +++ b/types/fusioncharts/themes/fusioncharts.theme.fint.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var fint: (H: FusionChartStatic) => FusionChartStatic; +declare function fint(H: FusionChartStatic): FusionChartStatic; export = fint; export as namespace fint; diff --git a/types/fusioncharts/themes/fusioncharts.theme.ocean.d.ts b/types/fusioncharts/themes/fusioncharts.theme.ocean.d.ts index 2f77db1f9b..cc7fbee84c 100644 --- a/types/fusioncharts/themes/fusioncharts.theme.ocean.d.ts +++ b/types/fusioncharts/themes/fusioncharts.theme.ocean.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var ocean: (H: FusionChartStatic) => FusionChartStatic; +declare function ocean(H: FusionChartStatic): FusionChartStatic; export = ocean; export as namespace ocean; diff --git a/types/fusioncharts/themes/fusioncharts.theme.zune.d.ts b/types/fusioncharts/themes/fusioncharts.theme.zune.d.ts index 2f76b88de5..ed3dc001a1 100644 --- a/types/fusioncharts/themes/fusioncharts.theme.zune.d.ts +++ b/types/fusioncharts/themes/fusioncharts.theme.zune.d.ts @@ -1,5 +1,5 @@ import { FusionChartStatic } from "fusioncharts"; -declare var zune: (H: FusionChartStatic) => FusionChartStatic; +declare function zune(H: FusionChartStatic): FusionChartStatic; export = zune; export as namespace zune; diff --git a/types/geojson/geojson-tests.ts b/types/geojson/geojson-tests.ts index 42ae99ce47..1e4fe3b392 100644 --- a/types/geojson/geojson-tests.ts +++ b/types/geojson/geojson-tests.ts @@ -64,17 +64,14 @@ let featureWithPolygon: GeoJSON.Feature = { properties: null }; - let point: GeoJSON.Point = { type: "Point", coordinates: [100.0, 0.0] }; - // This type is commonly used in the turf package let pointCoordinates: number[] = point.coordinates; - let lineString: GeoJSON.LineString = { type: "LineString", coordinates: [ [100.0, 0.0], [101.0, 1.0] ] diff --git a/types/geojson/index.d.ts b/types/geojson/index.d.ts index 7c825d2541..902b367d52 100644 --- a/types/geojson/index.d.ts +++ b/types/geojson/index.d.ts @@ -3,124 +3,119 @@ // Definitions by: Jacob Bruun // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare namespace GeoJSON { +export as namespace GeoJSON; - /*** - * http://geojson.org/geojson-spec.html#geojson-objects - */ - export interface GeoJsonObject { - type: string; - bbox?: number[]; - crs?: CoordinateReferenceSystem; - } - - /*** - * http://geojson.org/geojson-spec.html#positions - */ - export type Position = number[]; - - /*** - * http://geojson.org/geojson-spec.html#geometry-objects - */ - interface DirectGeometryObject extends GeoJsonObject { - coordinates: Position[][][] | Position[][] | Position[] | Position; - } - /** - * GeometryObject supports geometry collection as well - */ - export type GeometryObject = DirectGeometryObject | GeometryCollection; - - /*** - * http://geojson.org/geojson-spec.html#point - */ - export interface Point extends DirectGeometryObject { - type: 'Point'; - coordinates: Position; - } - - /*** - * http://geojson.org/geojson-spec.html#multipoint - */ - export interface MultiPoint extends DirectGeometryObject { - type: 'MultiPoint'; - coordinates: Position[]; - } - - /*** - * http://geojson.org/geojson-spec.html#linestring - */ - export interface LineString extends DirectGeometryObject { - type: 'LineString'; - coordinates: Position[]; - } - - /*** - * http://geojson.org/geojson-spec.html#multilinestring - */ - export interface MultiLineString extends DirectGeometryObject { - type: 'MultiLineString'; - coordinates: Position[][]; - } - - /*** - * http://geojson.org/geojson-spec.html#polygon - */ - export interface Polygon extends DirectGeometryObject { - type: 'Polygon'; - coordinates: Position[][]; - } - - /*** - * http://geojson.org/geojson-spec.html#multipolygon - */ - export interface MultiPolygon extends DirectGeometryObject { - type: 'MultiPolygon'; - coordinates: Position[][][]; - } - - /*** - * http://geojson.org/geojson-spec.html#geometry-collection - */ - export interface GeometryCollection extends GeoJsonObject { - type: 'GeometryCollection'; - geometries: GeometryObject[]; - } - - /*** - * http://geojson.org/geojson-spec.html#feature-objects - */ - export interface Feature extends GeoJsonObject { - type: 'Feature'; - geometry: T; - properties: {} | null; - id?: string; - } - - /*** - * http://geojson.org/geojson-spec.html#feature-collection-objects - */ - export interface FeatureCollection extends GeoJsonObject { - type: 'FeatureCollection'; - features: Array>; - } - - /*** - * http://geojson.org/geojson-spec.html#coordinate-reference-system-objects - */ - export interface CoordinateReferenceSystem { - type: string; - properties: any; - } - - export interface NamedCoordinateReferenceSystem extends CoordinateReferenceSystem { - properties: { name: string }; - } - - export interface LinkedCoordinateReferenceSystem extends CoordinateReferenceSystem { - properties: { href: string; type: string }; - } +/*** +* http://geojson.org/geojson-spec.html#geojson-objects +*/ +export interface GeoJsonObject { + type: string; + bbox?: number[]; + crs?: CoordinateReferenceSystem; } -declare module 'geojson' { - export = GeoJSON; +/*** +* http://geojson.org/geojson-spec.html#positions +*/ +export type Position = number[]; + +/*** +* http://geojson.org/geojson-spec.html#geometry-objects +*/ +interface DirectGeometryObject extends GeoJsonObject { + coordinates: Position[][][] | Position[][] | Position[] | Position; +} +/** + * GeometryObject supports geometry collection as well + */ +export type GeometryObject = DirectGeometryObject | GeometryCollection; + +/*** +* http://geojson.org/geojson-spec.html#point +*/ +export interface Point extends DirectGeometryObject { + type: 'Point'; + coordinates: Position; +} + +/*** +* http://geojson.org/geojson-spec.html#multipoint +*/ +export interface MultiPoint extends DirectGeometryObject { + type: 'MultiPoint'; + coordinates: Position[]; +} + +/*** +* http://geojson.org/geojson-spec.html#linestring +*/ +export interface LineString extends DirectGeometryObject { + type: 'LineString'; + coordinates: Position[]; +} + +/*** +* http://geojson.org/geojson-spec.html#multilinestring +*/ +export interface MultiLineString extends DirectGeometryObject { + type: 'MultiLineString'; + coordinates: Position[][]; +} + +/*** +* http://geojson.org/geojson-spec.html#polygon +*/ +export interface Polygon extends DirectGeometryObject { + type: 'Polygon'; + coordinates: Position[][]; +} + +/*** +* http://geojson.org/geojson-spec.html#multipolygon +*/ +export interface MultiPolygon extends DirectGeometryObject { + type: 'MultiPolygon'; + coordinates: Position[][][]; +} + +/*** +* http://geojson.org/geojson-spec.html#geometry-collection +*/ +export interface GeometryCollection extends GeoJsonObject { + type: 'GeometryCollection'; + geometries: GeometryObject[]; +} + +/*** +* http://geojson.org/geojson-spec.html#feature-objects +*/ +export interface Feature extends GeoJsonObject { + type: 'Feature'; + geometry: T; + properties: {} | null; + id?: string; +} + +/*** +* http://geojson.org/geojson-spec.html#feature-collection-objects +*/ +export interface FeatureCollection extends GeoJsonObject { + type: 'FeatureCollection'; + features: Array>; +} + +/*** +* http://geojson.org/geojson-spec.html#coordinate-reference-system-objects +*/ +export interface CoordinateReferenceSystem { + type: string; + properties: any; +} + +export interface NamedCoordinateReferenceSystem extends CoordinateReferenceSystem { + properties: { name: string }; +} + +export interface LinkedCoordinateReferenceSystem extends CoordinateReferenceSystem { + properties: { href: string; type: string }; } diff --git a/types/geolib/index.d.ts b/types/geolib/index.d.ts index 95779ab2c9..8842c3eb20 100644 --- a/types/geolib/index.d.ts +++ b/types/geolib/index.d.ts @@ -122,7 +122,8 @@ declare namespace geolib { /** Calculates the length of a collection of coordinates. * - * Returns the length of the path in meters */ + * Returns the length of the path in meters + */ function getPathLength(coords: PositionAsDecimal[]): number; /** Calculates the speed between two points within a given time span. diff --git a/types/geopattern/geopattern-tests.ts b/types/geopattern/geopattern-tests.ts index 957da81c20..7d5df87fc8 100644 --- a/types/geopattern/geopattern-tests.ts +++ b/types/geopattern/geopattern-tests.ts @@ -1,6 +1,6 @@ /// -var pattern = GeoPattern.generate('GitHub'); +const pattern = GeoPattern.generate('GitHub'); pattern.toDataUrl(); $('#geopattern').geopattern('GitHub'); diff --git a/types/gettext.js/gettext.js-tests.ts b/types/gettext.js/gettext.js-tests.ts index 6e5b4448ae..1603aec42a 100644 --- a/types/gettext.js/gettext.js-tests.ts +++ b/types/gettext.js/gettext.js-tests.ts @@ -2,10 +2,10 @@ import * as Gettext from 'gettext.js'; const json: Gettext.JsonData = { "": { - "locale": "fr", + locale: "fr", "plural-forms": "nplurals=2; plural=n>1;" }, - "Welcome": "Bienvenue", + Welcome: "Bienvenue", "There is %1 apple": [ "Il y a %1 pomme", "Il y a %1 pommes" diff --git a/types/gettext.js/index.d.ts b/types/gettext.js/index.d.ts index 5096490721..02a328ed84 100644 --- a/types/gettext.js/index.d.ts +++ b/types/gettext.js/index.d.ts @@ -28,18 +28,18 @@ export interface JsonData extends JsonDataMessages { } export interface Gettext { - setMessages: (domain: string, locale: string, messages: JsonDataMessages, plural_forms?: PluralForm) => Gettext; - loadJSON: (jsonData: JsonData, domain?: string) => Gettext; - setLocale: (locale: string) => Gettext; - getLocale: () => string; - textdomain: (domain?: string) => Gettext | string; - gettext: (msgid: string, ...args: any[]) => string; - ngettext: (msgid: string, msgid_plural: string, n: number, ...args: any[]) => string; - pgettext: (msgctxt: string, msgid: string, ...args: any[]) => string; - dcnpgettext: (domain: string, msgctxt: string, msgid: string, msgid_plural: string, n: number, ...args: any[]) => string; - __: (msgid: string, ...args: any[]) => string; - _n: (msgid: string, msgid_plural: string, n: number, ...args: any[]) => string; - _p: (msgctxt: string, msgid: string, ...args: any[]) => string; + setMessages(domain: string, locale: string, messages: JsonDataMessages, plural_forms?: PluralForm): Gettext; + loadJSON(jsonData: JsonData, domain?: string): Gettext; + setLocale(locale: string): Gettext; + getLocale(): string; + textdomain(domain?: string): Gettext | string; + gettext(msgid: string, ...args: any[]): string; + ngettext(msgid: string, msgid_plural: string, n: number, ...args: any[]): string; + pgettext(msgctxt: string, msgid: string, ...args: any[]): string; + dcnpgettext(domain: string, msgctxt: string, msgid: string, msgid_plural: string, n: number, ...args: any[]): string; + __(msgid: string, ...args: any[]): string; + _n(msgid: string, msgid_plural: string, n: number, ...args: any[]): string; + _p(msgctxt: string, msgid: string, ...args: any[]): string; } export const i18n: GettextStatic; diff --git a/types/globule/index.d.ts b/types/globule/index.d.ts index 08f00ec082..7918acbeae 100644 --- a/types/globule/index.d.ts +++ b/types/globule/index.d.ts @@ -21,7 +21,7 @@ interface MappingOptions extends FindOptions { ext?: string; extDot?: 'first' | 'last'; flatten?: boolean; - rename?: (p: string) => string; + rename?(p: string): string; } interface OneMapping { diff --git a/types/google-map-react/google-map-react-tests.tsx b/types/google-map-react/google-map-react-tests.tsx index 9cec9138e2..959bb8e68a 100644 --- a/types/google-map-react/google-map-react-tests.tsx +++ b/types/google-map-react/google-map-react-tests.tsx @@ -3,4 +3,4 @@ import * as React from 'react'; const center = { lat: 0, lng: 0 }; - +; diff --git a/types/google-map-react/index.d.ts b/types/google-map-react/index.d.ts index 45ce0341a6..98fb290e5d 100644 --- a/types/google-map-react/index.d.ts +++ b/types/google-map-react/index.d.ts @@ -15,7 +15,7 @@ export interface Options { styles?: any[]; scrollwheel?: boolean; panControl?: boolean; - mapTypeControl?: boolean, + mapTypeControl?: boolean; minZoomOverride?: boolean; minZoom?: number; gestureHandling?: string; @@ -59,18 +59,18 @@ export interface Props { margin?: any[]; debounced?: boolean; layerTypes?: string[]; - onClick?: ({x, y, lat, lng, event}: { x: number, y: number, lat: number, lng: number, event: any }) => any; - onChange?: ({ center, zoom, bounds, marginBounds }: { center: [number, number], zoom: number, bounds: [number, number, number, number], marginBounds: [number, number, number, number] }) => any; + onClick?({x, y, lat, lng, event}: { x: number, y: number, lat: number, lng: number, event: any }): any; + onChange?({ center, zoom, bounds, marginBounds }: { center: [number, number], zoom: number, bounds: [number, number, number, number], marginBounds: [number, number, number, number] }): any; resetBoundsOnResize?: boolean; - onChildClick?: (hoverKey: any, childProps: any) => void; - onChildMouseEnter?: (hoverKey: any, childProps: any) => void; - onChildMouseLeave?: (hoverKey: any, childProps: any) => void; - onZoomAnimationStart?: (args: any) => void; - onZoomAnimationEnd?: (args: any) => void; - onMapTypeIdChange?: (args: any) => void; - distanceToMouse?: (pt: {x: number, y: number}, mousePos: {x: number, y: number}) => void; - googleMapLoader?: (bootstrapURLKeys: any) => void; - onGoogleApiLoaded?: ({map, maps}: { map: any, maps: any }) => void; + onChildClick?(hoverKey: any, childProps: any): void; + onChildMouseEnter?(hoverKey: any, childProps: any): void; + onChildMouseLeave?(hoverKey: any, childProps: any): void; + onZoomAnimationStart?(args: any): void; + onZoomAnimationEnd?(args: any): void; + onMapTypeIdChange?(args: any): void; + distanceToMouse?(pt: {x: number, y: number}, mousePos: {x: number, y: number}): void; + googleMapLoader?(bootstrapURLKeys: any): void; + onGoogleApiLoaded?({map, maps}: { map: any, maps: any }): void; yesIWantToUseGoogleMapApiInternals?: boolean; } diff --git a/types/google-protobuf/tslint.json b/types/google-protobuf/tslint.json index fdc7cdc370..a980701dab 100644 --- a/types/google-protobuf/tslint.json +++ b/types/google-protobuf/tslint.json @@ -1,3 +1,16 @@ { - "extends": "../tslint.json" + "extends": "../tslint.json", + "rules": { + "align": false, + "array-type": false, + "new-parens": false, + "no-consecutive-blank-lines": false, + "no-redundant-modifiers": false, + "interface-over-type-literal": false, + "no-relative-import-in-test": false, + "no-var": false, + "prefer-declare-function": false, + "semicolon": false, + "trim-file": false + } } \ No newline at end of file diff --git a/types/google.analytics/index.d.ts b/types/google.analytics/index.d.ts index 088ce364e1..ad292f7fe1 100644 --- a/types/google.analytics/index.d.ts +++ b/types/google.analytics/index.d.ts @@ -542,30 +542,63 @@ declare namespace UniversalAnalytics { l: number; q: any[]; - (command: 'send', hitType: 'event', eventCategory: string, eventAction: string, - eventLabel?: string, eventValue?: number, fieldsObject?: FieldsObject): void; - (command: 'send', hitType: 'event', fieldsObject: { + ( + command: 'send', + hitType: 'event', eventCategory: string, eventAction: string, eventLabel?: string, eventValue?: number, - nonInteraction?: boolean}): void; - (command: 'send', fieldsObject: { - hitType: HitType, // 'event' - eventCategory: string, - eventAction: string, - eventLabel?: string, - eventValue?: number, - nonInteraction?: boolean}): void; + fieldsObject?: FieldsObject): void; + ( + command: 'send', + hitType: 'event', + fieldsObject: { + eventCategory: string, + eventAction: string, + eventLabel?: string, + eventValue?: number, + nonInteraction?: boolean + }): void; + ( + command: 'send', + fieldsObject: { + hitType: HitType, // 'event' + eventCategory: string, + eventAction: string, + eventLabel?: string, + eventValue?: number, + nonInteraction?: boolean + }): void; (command: 'send', hitType: 'pageview', page: string): void; - (command: 'send', hitType: 'social', - socialNetwork: string, socialAction: string, socialTarget: string): void; - (command: 'send', hitType: 'social', - fieldsObject: {socialNetwork: string, socialAction: string, socialTarget: string}): void; - (command: 'send', hitType: 'timing', - timingCategory: string, timingVar: string, timingValue: number): void; - (command: 'send', hitType: 'timing', - fieldsObject: {timingCategory: string, timingVar: string, timingValue: number}): void; + ( + command: 'send', + hitType: 'social', + socialNetwork: string, + socialAction: string, + socialTarget: string): void; + ( + command: 'send', + hitType: 'social', + fieldsObject: { + socialNetwork: string, + socialAction: string, + socialTarget: string + }): void; + ( + command: 'send', + hitType: 'timing', + timingCategory: string, + timingVar: string, + timingValue: number): void; + ( + command: 'send', + hitType: 'timing', + fieldsObject: { + timingCategory: string, + timingVar: string, + timingValue: number + }): void; (command: 'send', fieldsObject: FieldsObject): void; (command: string, hitType: HitType, ...fields: any[]): void; diff --git a/types/graphite-udp/index.d.ts b/types/graphite-udp/index.d.ts index e36afa76d0..b3e843b0d4 100644 --- a/types/graphite-udp/index.d.ts +++ b/types/graphite-udp/index.d.ts @@ -60,7 +60,7 @@ interface ClientOptions { * @param {metrics} * @return void */ - callback?: (error: Error, metrics: any) => void; + callback?(error: Error, metrics: any): void; } export class Client { diff --git a/types/graphql-relay/graphql-relay-tests.ts b/types/graphql-relay/graphql-relay-tests.ts index 723ffa393b..a451f0faab 100644 --- a/types/graphql-relay/graphql-relay-tests.ts +++ b/types/graphql-relay/graphql-relay-tests.ts @@ -149,7 +149,7 @@ const prf: GraphQLFieldConfig = pluralIdentifyingRootField({ // An example usage of these methods from the test schema: const {nodeInterface, nodeField} = nodeDefinitions( (globalId) => { - var {type, id} = fromGlobalId(globalId); + const {type, id} = fromGlobalId(globalId); return "data[type][id]"; }, (obj) => { @@ -180,7 +180,8 @@ mutationWithClientMutationId({ name: "M", description: "D", inputFields: gifcm, - mutateAndGetPayload: (object: any, + mutateAndGetPayload: ( + object: any, ctx: any, info: GraphQLResolveInfo) => { return new Promise((resolve) => { @@ -191,7 +192,7 @@ mutationWithClientMutationId({ }); // An example usage of these methods from the test schema: const data: any = {}; -var shipMutation = mutationWithClientMutationId({ +const shipMutation = mutationWithClientMutationId({ name: 'IntroduceShip', inputFields: { shipName: { @@ -212,7 +213,7 @@ var shipMutation = mutationWithClientMutationId({ } }, mutateAndGetPayload: ({shipName, factionId}) => { - var newShip = { + const newShip = { id: "11", name: shipName }; @@ -225,7 +226,7 @@ var shipMutation = mutationWithClientMutationId({ } }); -var mutationType = new GraphQLObjectType({ +const mutationType = new GraphQLObjectType({ name: 'Mutation', fields: () => ({ introduceShip: shipMutation diff --git a/types/graphql-relay/index.d.ts b/types/graphql-relay/index.d.ts index 3672a2d1c0..ce6ba8a7e2 100644 --- a/types/graphql-relay/index.d.ts +++ b/types/graphql-relay/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Arvitaly , nitintutlani , Grelinfo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - import { GraphQLBoolean, GraphQLInt, @@ -123,7 +122,6 @@ interface ConnectionArguments { last?: number; } - // connection/arrayconnection.js interface ArraySliceMetaInfo { @@ -154,11 +152,11 @@ export function connectionFromPromisedArray( * Given a slice (subset) of an array, returns a connection object for use in * GraphQL. * -* This function is similar to `connectionFromArray`, but is intended for use -* cases where you know the cardinality of the connection, consider it too large -* to materialize the entire array, and instead wish pass in a slice of the -* total result large enough to cover the range specified in `args`. -*/ + * This function is similar to `connectionFromArray`, but is intended for use + * cases where you know the cardinality of the connection, consider it too large + * to materialize the entire array, and instead wish pass in a slice of the + * total result large enough to cover the range specified in `args`. + */ export function connectionFromArraySlice( arraySlice: T[], args: ConnectionArguments, @@ -294,17 +292,16 @@ export function globalIdField( idFetcher?: (object: any, context: any, info: GraphQLResolveInfo) => string ): GraphQLFieldConfig; - // node/plural.js interface PluralIdentifyingRootFieldConfig { argName: string; inputType: GraphQLInputType; outputType: GraphQLOutputType; - resolveSingleInput: (input: any, context: any, info: GraphQLResolveInfo) => any; + resolveSingleInput(input: any, context: any, info: GraphQLResolveInfo): any; description?: string; } export function pluralIdentifyingRootField( config: PluralIdentifyingRootFieldConfig -): GraphQLFieldConfig; \ No newline at end of file +): GraphQLFieldConfig; diff --git a/types/griddle-react/test/CustomColumnComponent.tsx b/types/griddle-react/test/CustomColumnComponent.tsx index e47b2c36bb..fff018dcfb 100644 --- a/types/griddle-react/test/CustomColumnComponent.tsx +++ b/types/griddle-react/test/CustomColumnComponent.tsx @@ -64,7 +64,7 @@ class CustomColumnComponentGrid extends React.Component { sortDescendingComponent={} customRowComponent={LinkComponent} /> ); - }; + } } export default CustomColumnComponentGrid; diff --git a/types/gsap/gsap-tests.ts b/types/gsap/gsap-tests.ts index f811ac1089..048a9d522e 100644 --- a/types/gsap/gsap-tests.ts +++ b/types/gsap/gsap-tests.ts @@ -1,6 +1,6 @@ import { TweenLite } from 'gsap'; -var tween = TweenLite +const tween = TweenLite .to(document.getElementById('some-div'), 1, { width: '200px', height: '200px' diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index fe4cfeb112..e28562a08f 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -91,7 +91,6 @@ declare namespace __Handsontable { updateSettings(settings: Object, init?: boolean): void; validateCells(callback: Function): void; } - } declare namespace Handsontable { @@ -507,7 +506,6 @@ declare namespace Handsontable { } declare class Handsontable extends __Handsontable.Core { - constructor (element: Element, options: Handsontable.Options); static plugins: Handsontable.Plugins; static hooks: Handsontable.Hooks; static Dom: Handsontable.Dom; diff --git a/types/hapi-auth-jwt2/hapi-auth-jwt2-tests.ts b/types/hapi-auth-jwt2/hapi-auth-jwt2-tests.ts index e6eeb6a055..d0bf1b8688 100644 --- a/types/hapi-auth-jwt2/hapi-auth-jwt2-tests.ts +++ b/types/hapi-auth-jwt2/hapi-auth-jwt2-tests.ts @@ -1,7 +1,7 @@ import Hapi = require('hapi'); import hapiAuthJwt2 = require('hapi-auth-jwt2'); -var server = new Hapi.Server(); +const server = new Hapi.Server(); server.connection({port: 8000}); interface User { @@ -13,7 +13,7 @@ interface Users { [id: number]: User; } -var users: Users = { +const users: Users = { 1: { id: 1, name: 'Test User' diff --git a/types/hapi-auth-jwt2/index.d.ts b/types/hapi-auth-jwt2/index.d.ts index 1bcbbc817e..055cbd9ce7 100644 --- a/types/hapi-auth-jwt2/index.d.ts +++ b/types/hapi-auth-jwt2/index.d.ts @@ -33,93 +33,93 @@ type KeyLookupCallback = (err: any, key: string, extraInfo?: any) => void; type ValidateCallback = (err: any, valid: boolean, credentials?: any) => void; /** - * Options passed to `hapi.auth.strategy` when this plugin is used - */ + * Options passed to `hapi.auth.strategy` when this plugin is used + */ export interface Options { /** - * The secret key used to check the signature of the token *or* a *key lookup function* - */ + * The secret key used to check the signature of the token *or* a *key lookup function* + */ key?: string | KeyLookup; /** - * The function which is run once the Token has been decoded - * - * @param decoded the *decoded* and *verified* JWT received from the client in *request.headers.authorization* - * @param request the original *request* received from the client - * @param callback the validation callback - */ + * The function which is run once the Token has been decoded + * + * @param decoded the *decoded* and *verified* JWT received from the client in *request.headers.authorization* + * @param request the original *request* received from the client + * @param callback the validation callback + */ validateFunc(decoded: {}, request: Request, callback: ValidateCallback): void; /** - * Settings to define how tokens are verified by the jsonwebtoken library - */ + * Settings to define how tokens are verified by the jsonwebtoken library + */ verifyOptions?: { /** - * Ignore expired tokens - */ + * Ignore expired tokens + */ ignoreExpiration?: boolean; /** - * Do not enforce token audience - */ + * Do not enforce token audience + */ audience?: boolean; /** - * Do not require the issuer to be valid - */ + * Do not require the issuer to be valid + */ issuer?: boolean; /** - * List of allowed algorithms - */ + * List of allowed algorithms + */ algorithms?: string[]; }; /** - * function called to decorate the response with authentication headers - * before the response headers or payload is written - * - * @param request the Request object - * @param reply is called if an error occurred - */ + * function called to decorate the response with authentication headers + * before the response headers or payload is written + * + * @param request the Request object + * @param reply is called if an error occurred + */ responseFunc?(request: Request, reply: (err: any, response: Response) => void): void; /** - * If you prefer to pass your token via url, simply add a token url - * parameter to your request or use a custom parameter by setting `urlKey. - * To disable the url parameter set urlKey to `false` or ''. - * @default 'token' - */ + * If you prefer to pass your token via url, simply add a token url + * parameter to your request or use a custom parameter by setting `urlKey. + * To disable the url parameter set urlKey to `false` or ''. + * @default 'token' + */ urlKey?: string | boolean; /** - * If you prefer to set your own cookie key or your project has a cookie - * called 'token' for another purpose, you can set a custom key for your - * cookie by setting `options.cookieKey='yourkeyhere'`. To disable cookies - * set cookieKey to `false` or ''. - * @default 'token' - */ + * If you prefer to set your own cookie key or your project has a cookie + * called 'token' for another purpose, you can set a custom key for your + * cookie by setting `options.cookieKey='yourkeyhere'`. To disable cookies + * set cookieKey to `false` or ''. + * @default 'token' + */ cookieKey?: string | boolean; /** - * If you want to set a custom key for your header token use the - * `headerKey` option. To disable header token set headerKey to `false` or - * ''. - * @default 'authorization' - */ + * If you want to set a custom key for your header token use the + * `headerKey` option. To disable header token set headerKey to `false` or + * ''. + * @default 'authorization' + */ headerKey?: string | boolean; /** - * Allow custom token type, e.g. `Authorization: 12345678` - */ + * Allow custom token type, e.g. `Authorization: 12345678` + */ tokenType?: string; /** - * Set to `true` to receive the complete token (`decoded.header`, - * `decoded.payload` and `decoded.signature`) as decoded argument to key - * lookup and `verifyFunc` callbacks (*not `validateFunc`*) - * @default false - */ + * Set to `true` to receive the complete token (`decoded.header`, + * `decoded.payload` and `decoded.signature`) as decoded argument to key + * lookup and `verifyFunc` callbacks (*not `validateFunc`*) + * @default false + */ complete?: boolean; } diff --git a/types/har-format/index.d.ts b/types/har-format/index.d.ts index 7aaf479891..09ea2791fd 100644 --- a/types/har-format/index.d.ts +++ b/types/har-format/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Michael Mrowetz // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - /** * HTTP Archive 1.2 * diff --git a/types/highcharts/highstock.d.ts b/types/highcharts/highstock.d.ts index f67a83ba37..64c3041d49 100644 --- a/types/highcharts/highstock.d.ts +++ b/types/highcharts/highstock.d.ts @@ -105,7 +105,7 @@ declare global { * a div selected by $('#container') * @param {Highcharts.Options} options Options for this chart * @return current {JQuery} selector the current JQuery selector - **/ + */ highcharts(type: "StockChart", options: Highstock.Options): JQuery; /** * Creates a new Highcharts.Chart for the current JQuery selector; usually @@ -113,7 +113,7 @@ declare global { * @param {Highcharts.Options} options Options for this chart * @param callback Callback function used to manipulate the constructed chart instance * @return current {JQuery} selector the current JQuery selector - **/ + */ highcharts(type: "StockChart", options: Highstock.Options, callback: (chart: Highstock.ChartObject) => void): JQuery; highcharts(type: string): Highcharts.ChartObject; @@ -122,6 +122,6 @@ declare global { } } -declare var Highstock: Highstock.Static; +declare const Highstock: Highstock.Static; export = Highstock; export as namespace Highstock; diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index 952de318b0..8cc623b680 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -728,11 +728,11 @@ declare namespace Highcharts { */ showLastLabel?: boolean; /** - * Show the total value for each bar in a stacked column or bar chart. - * The label will be placed on top of positive columns and below negative columns. - * In case of an inverted column chart or a bar chart the label is placed to the right of positive bars and to the left of negative bars. - * Only used for yAxis - */ + * Show the total value for each bar in a stacked column or bar chart. + * The label will be placed on top of positive columns and below negative columns. + * In case of an inverted column chart or a bar chart the label is placed to the right of positive bars and to the left of negative bars. + * Only used for yAxis + */ stackLabels?: { /** * Defines the horizontal alignment of the stack total label. Can be one of "left", "center" or "right". @@ -820,7 +820,7 @@ declare namespace Highcharts { * Use this in cases where a linear gradient between a minColor and maxColor is not sufficient. * The stops is an array of tuples, where the first item is a float between 0 and 1 assigning the relative position in the gradient, and the second item is the color. */ - stops?: [number, string][]; + stops?: Array<[number, string]>; /** * The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within * a chart. This option overrides the tickPixelInterval option. @@ -1133,7 +1133,7 @@ declare namespace Highcharts { * and maxColor is not sufficient. The stops is an array of tuples, where the first item is a float between 0 and 1 * assigning the relative position in the gradient, and the second item is the color. */ - stops?: [number, string][]; + stops?: Array<[number, string]>; /** * Color for the main tick marks. * @default '#C0D0E0' @@ -1879,7 +1879,7 @@ declare namespace Highcharts { * switchRowsAndColumns is set, the columns are interpreted as series. * @since 4.0 */ - columns?: [string | number][]; + columns?: Array<[string | number]>; /** * The callback that is evaluated when the data is finished loading, optionally from an external source, and parsed. * The first argument passed is a finished chart options object, containing the series. These options can be @@ -1962,12 +1962,12 @@ declare namespace Highcharts { * async. * @since 4.0 */ - parsed?(columns: [string | number][]): boolean | void; + parsed?(columns: Array<[string | number]>): boolean | void; /** * The same as the columns input option, but defining rows intead of columns. * @since 4.0 */ - rows?: [string | number][]; + rows?: Array<[string | number]>; /** * An array containing object with Point property names along with what column id the property should be taken from. * @since 4.0.4 @@ -5012,7 +5012,7 @@ declare namespace Highcharts { * color: '#FF00FF' * }] */ - data?: number[] | [number, number][] | [string, number][] | DataPoint[]; + data?: number[] | Array<[number, number]> | Array<[string, number]> | DataPoint[]; /** * An id for the series. This can be used after render time to get a pointer to the series object through * chart.get(). @@ -6529,23 +6529,23 @@ declare global { interface JQuery { highcharts(): Highcharts.ChartObject; /** - * Creates a new Highcharts.Chart for the current JQuery selector; usually - * a div selected by $('#container') - * @param {Options} options Options for this chart - * @return current {JQuery} selector the current JQuery selector - **/ + * Creates a new Highcharts.Chart for the current JQuery selector; usually + * a div selected by $('#container') + * @param {Options} options Options for this chart + * @return current {JQuery} selector the current JQuery selector + */ highcharts(options: Highcharts.Options): JQuery; /** - * Creates a new Highcharts.Chart for the current JQuery selector; usually - * a div selected by $('#container') - * @param {Options} options Options for this chart - * @param callback Callback function used to manipulate the constructed chart instance - * @return current {JQuery} selector the current JQuery selector - **/ + * Creates a new Highcharts.Chart for the current JQuery selector; usually + * a div selected by $('#container') + * @param {Options} options Options for this chart + * @param callback Callback function used to manipulate the constructed chart instance + * @return current {JQuery} selector the current JQuery selector + */ highcharts(options: Highcharts.Options, callback: (chart: Highcharts.ChartObject) => void): JQuery; } } -declare var Highcharts: Highcharts.Static; +declare const Highcharts: Highcharts.Static; export = Highcharts; export as namespace Highcharts; diff --git a/types/highcharts/modules/map/index.d.ts b/types/highcharts/modules/map/index.d.ts index 04d5a77aea..7e3b126e47 100644 --- a/types/highcharts/modules/map/index.d.ts +++ b/types/highcharts/modules/map/index.d.ts @@ -26,11 +26,11 @@ declare module 'highcharts' { } interface MapSeriesOptions { - data?: number[] | [number, number][] | [string, number][] | highcharts.DataPoint[]; + data?: number[] | Array<[number, number]> | Array<[string, number]> | highcharts.DataPoint[]; dataLabels?: MapSeriesOptionsDataLabels; - joinBy?: Array; + joinBy?: string[]; mapData?: geojson.GeoJsonObject; diff --git a/types/highcharts/tslint.json b/types/highcharts/tslint.json index a53062e5df..637005d33b 100644 --- a/types/highcharts/tslint.json +++ b/types/highcharts/tslint.json @@ -3,7 +3,6 @@ "rules": { "ban-types": false, "unified-signatures": false, - "array-type": false, "no-empty-interface": false, "dt-header": false } diff --git a/types/hoek/hoek-tests.ts b/types/hoek/hoek-tests.ts index bb2ac87389..45487c2f45 100644 --- a/types/hoek/hoek-tests.ts +++ b/types/hoek/hoek-tests.ts @@ -172,7 +172,7 @@ const source1 = { let result = Hoek.transform(source1, { 'person.address.lineOne': 'address.one', 'person.address.lineTwo': 'address.two', - 'title': 'title', + title: 'title', 'person.address.region': 'state' }); // Results in @@ -231,7 +231,8 @@ a = Hoek.escapeRegex('4^f$s.4*5+-_?%=#!:@|~\\/`"(>)[<]d{}s,'); // returns 4\^f\ // assert(condition, message) -const x = 1, y = 2 as number; +const x = 1; +const y = 2 as number; Hoek.assert(x === y, 'x should equal y'); // Throws 'x should equal y' diff --git a/types/hoek/index.d.ts b/types/hoek/index.d.ts index e1ea52677b..dfc7aa58ae 100644 --- a/types/hoek/index.d.ts +++ b/types/hoek/index.d.ts @@ -34,16 +34,17 @@ export function clone(obj: T): T; /** * Clone an object or array. - * */ + */ export function cloneWithShallow(obj: any, keys: string[]): any; /** - * Merge all the properties of source into target. */ + * Merge all the properties of source into target. + */ export function merge(target: T1, source: T2, isNullOverride?: boolean, isMergeArrays?: boolean): T1 & T2; /** * Apply options to a copy of the defaults. - * */ + */ export function applyToDefaults(defaults: T1, options: T2, isNullOverride?: boolean): T1 & T2; /** diff --git a/types/html-webpack-plugin/index.d.ts b/types/html-webpack-plugin/index.d.ts index 792c7a2dc0..797fce3388 100644 --- a/types/html-webpack-plugin/index.d.ts +++ b/types/html-webpack-plugin/index.d.ts @@ -84,5 +84,5 @@ declare namespace HtmlWebpackPlugin { /** @deprecated use MinifyOptions */ type MinifyConfig = MinifyOptions; /** @deprecated use Options */ - type Config = Options; + type Config = Options; } diff --git a/types/hyperscript/hyperscript-tests.ts b/types/hyperscript/hyperscript-tests.ts index f4bab0550a..687a2591c1 100644 --- a/types/hyperscript/hyperscript-tests.ts +++ b/types/hyperscript/hyperscript-tests.ts @@ -56,3 +56,28 @@ h2('a', {href: '#', }, "Click this") h2.cleanup() + +/* Polymorphic type tests */ + +// fall back to Element when in doubt +let fallbackTest = h('canvas#test3'); + +// determine proper Element type from tagName +let htmlTest1: HTMLCanvasElement = h('canvas'); + +// allow coercion of decorated tagName to proper type +let htmlTest2: HTMLCanvasElement = h('canvas#test2'); + +// if you need it to be an HTMLElement, you must coerce +let htmlTest3 = h('canvas#test3'); + +// support SVG elements +let svgTest1 = h('svg'); + +// allow coercions on SVG elements +let svgTest2 = h('svg#test5'); + +// inline coercion if you were feeling pedantic +h('div#page', + h('div#header', + h('h1.classy', 'h', { style: {'background-color': '#22f'} }))); \ No newline at end of file diff --git a/types/hyperscript/index.d.ts b/types/hyperscript/index.d.ts index 4274365404..cec67e56ab 100644 --- a/types/hyperscript/index.d.ts +++ b/types/hyperscript/index.d.ts @@ -1,13 +1,15 @@ // Type definitions for hyperscript // Project: https://github.com/dominictarr/hyperscript -// Definitions by: Mike Linkovich +// Definitions by: Mike Linkovich , Justin Firth // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 declare module 'hyperscript' { interface HyperScript { - /** Creates an HTML element */ - (tagName: string, ...args: any[]): HTMLElement; + /** Creates an Element */ + (tagName: T, attrs?: Object, ...children: any[]): ElementTagNameMap[T]; + (tagName: string, attrs?: Object, ...children: any[]): T; /** Cleans up any event handlers created by this hyperscript context */ cleanup(): void; /** Creates a new hyperscript context */ diff --git a/types/ignite-ui/index.d.ts b/types/ignite-ui/index.d.ts index 7052460f8b..d93cb1f9e6 100644 --- a/types/ignite-ui/index.d.ts +++ b/types/ignite-ui/index.d.ts @@ -5,13 +5,13 @@ interface DataSourceSettingsPaging { /** - * Paging is not enabled by default + * Paging is not enabled by default * */ enabled?: boolean; /** - * Type for the paging operation + * Type for the paging operation * * * Valid values: @@ -21,44 +21,44 @@ interface DataSourceSettingsPaging { type?: string; /** - * Number of records on each page + * Number of records on each page * */ pageSize?: number; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page size + * Denotes the name of the encoded URL parameter that will state what is the currently requested page size * */ pageSizeUrlKey?: string; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page index + * Denotes the name of the encoded URL parameter that will state what is the currently requested page index * */ pageIndexUrlKey?: string; /** - * Current page index + * Current page index * */ pageIndex?: number; /** - * Whether when a new page of data is requested we should append the new data to the existing data + * Whether when a new page of data is requested we should append the new data to the existing data * */ appendPage?: boolean; /** - * Option for DataSourceSettingsPaging + * Option for DataSourceSettingsPaging */ [optionName: string]: any; } interface DataSourceSettingsFiltering { /** - * Filtering type. + * Filtering type. * * Valid values: * "remote" Parameters will be encoded and it's up to the backend to interpred them from the response. @@ -67,68 +67,68 @@ interface DataSourceSettingsFiltering { type?: string; /** - * Enables or disables case sensitive filtering on the data. Works only for local filtering + * Enables or disables case sensitive filtering on the data. Works only for local filtering * */ caseSensitive?: boolean; /** - * If the type of paging/sorting/filtering is local and applyToAllData is true, filtering will be performed on the whole data source that's present locally, otherwise only on the current dataView. if type is remote, this setting doesn't have any effect. + * If the type of paging/sorting/filtering is local and applyToAllData is true, filtering will be performed on the whole data source that's present locally, otherwise only on the current dataView. if type is remote, this setting doesn't have any effect. * */ applyToAllData?: boolean; /** - * Can point to either a string or a function object. The parameters that are passed are 1) the data array to be filtered, 2) the filtering expression definitions. Should return an array of the filtered data + * Can point to either a string or a function object. The parameters that are passed are 1) the data array to be filtered, 2) the filtering expression definitions. Should return an array of the filtered data * */ customFunc?: any; /** - * Url key that will be encoded in the request if remote filtering is performed. Default value of null implies OData-style URL encoding. Please see http://www.odata.org/developers/protocols/uri-conventions for details + * Url key that will be encoded in the request if remote filtering is performed. Default value of null implies OData-style URL encoding. Please see http://www.odata.org/developers/protocols/uri-conventions for details * */ filterExprUrlKey?: string; /** - * Url key that will be encoded in the request, specifying if the filtering logic will be AND or OR + * Url key that will be encoded in the request, specifying if the filtering logic will be AND or OR * */ filterLogicUrlKey?: string; /** - * Data will be initially filtered accordingly, directly after dataBind() + * Data will be initially filtered accordingly, directly after dataBind() * */ defaultFields?: any[]; /** - * A list of expression objects, containing the following key-value pairs: fieldName, expression (search string), condition , and logic (AND/OR) + * A list of expression objects, containing the following key-value pairs: fieldName, expression (search string), condition , and logic (AND/OR) * */ expressions?: any[]; /** - * An "SQL-like' encoded expressions string. Takes precedence over "expressions". Example: col2 > 100; col2 LIKE %test% + * An "SQL-like' encoded expressions string. Takes precedence over "expressions". Example: col2 > 100; col2 LIKE %test% * */ exprString?: string; /** - * An object containing custom defined filtering conditions as objects. + * An object containing custom defined filtering conditions as objects. * */ customConditions?: any; /** - * Option for DataSourceSettingsFiltering + * Option for DataSourceSettingsFiltering */ [optionName: string]: any; } interface DataSourceSettingsSorting { /** - * Sorting direction + * Sorting direction * * * Valid values: @@ -139,37 +139,37 @@ interface DataSourceSettingsSorting { defaultDirection?: string; /** - * When defaultDirection is different than "none", and defaultFields is specified, data will be initially sorted accordingly, directly after dataBind() + * When defaultDirection is different than "none", and defaultFields is specified, data will be initially sorted accordingly, directly after dataBind() * */ defaultFields?: any[]; /** - * If the sorting type is local and applyToAllData is true, sorting will be performed on the whole data source that's present locally, otherwise only on the current dataView. If sorting type is remote, this setting doesn't have any effect. + * If the sorting type is local and applyToAllData is true, sorting will be performed on the whole data source that's present locally, otherwise only on the current dataView. If sorting type is remote, this setting doesn't have any effect. * */ applyToAllData?: boolean; /** - * Custom sorting function that can point to either a string or a function object. When the function is called, the following arguments are passed: data array, fields (array of field definitions) , direction ("asc" or "desc"). The function should return a sorted data array + * Custom sorting function that can point to either a string or a function object. When the function is called, the following arguments are passed: data array, fields (array of field definitions) , direction ("asc" or "desc"). The function should return a sorted data array * */ customFunc?: any; /** - * Custom comparison sorting function. Accepts the following arguments: fields, schema, booleand value whether sorting is ascending , convert function(please check option for customConvertFunc) and returns a value 0 indicating that values are equal, 1 indicating that val1 > val2 and -1 indicating that val1 < val2 + * Custom comparison sorting function. Accepts the following arguments: fields, schema, booleand value whether sorting is ascending , convert function(please check option for customConvertFunc) and returns a value 0 indicating that values are equal, 1 indicating that val1 > val2 and -1 indicating that val1 < val2 * */ compareFunc?: any; /** - * Custom data value conversion function(called from sorting function). Accepts a value of the data cell and column key and should return the converted value + * Custom data value conversion function(called from sorting function). Accepts a value of the data cell and column key and should return the converted value * */ customConvertFunc?: any; /** - * Specifies whether sorting will be applied locally or remotely (via a remote request) + * Specifies whether sorting will be applied locally or remotely (via a remote request) * * * Valid values: @@ -179,63 +179,63 @@ interface DataSourceSettingsSorting { type?: string; /** - * Specifies if sorting will be case sensitive or not. Works only for local sorting + * Specifies if sorting will be case sensitive or not. Works only for local sorting * */ caseSensitive?: boolean; /** - * URL param name which specifies how sorting expressions will be encoded in the URL. Default is null and uses OData conventions + * URL param name which specifies how sorting expressions will be encoded in the URL. Default is null and uses OData conventions * */ sortUrlKey?: string; /** - * URL param value for ascending type of sorting. Default is null and uses OData conventions + * URL param value for ascending type of sorting. Default is null and uses OData conventions * */ sortUrlAscValueKey?: string; /** - * URL param value for descending type of sorting. Default is null and uses OData conventions + * URL param value for descending type of sorting. Default is null and uses OData conventions * */ sortUrlDescValueKey?: string; /** - * A list of sorting expressions , consisting of the following keys (and their respective values): fieldName, direction and compareFunc (optional) + * A list of sorting expressions , consisting of the following keys (and their respective values): fieldName, direction and compareFunc (optional) * */ expressions?: any[]; /** - * Takes precedence over experssions, an "SQL-like" encoded expressions string : see sort(). Example col2 > 100 ORDER BY asc + * Takes precedence over experssions, an "SQL-like" encoded expressions string : see sort(). Example col2 > 100 ORDER BY asc * */ exprString?: string; /** - * Option for DataSourceSettingsSorting + * Option for DataSourceSettingsSorting */ [optionName: string]: any; } interface DataSourceSettingsGroupby { /** - * Default collapse state + * Default collapse state * */ defaultCollapseState?: boolean; /** - * Option for DataSourceSettingsGroupby + * Option for DataSourceSettingsGroupby */ [optionName: string]: any; } interface DataSourceSettingsSummaries { /** - * Specifies whether summaries will be applied locally or remotely (via a remote request) + * Specifies whether summaries will be applied locally or remotely (via a remote request) * * * Valid values: @@ -245,19 +245,19 @@ interface DataSourceSettingsSummaries { type?: string; /** - * Url key for retrieving data from response - used only when summaries are remote + * Url key for retrieving data from response - used only when summaries are remote * */ summaryExprUrlKey?: string; /** - * Key for retrieving data from the summaries response - used only when summaries are remote + * Key for retrieving data from the summaries response - used only when summaries are remote * */ summariesResponseKey?: string; /** - * Determines when the summary values are calculated + * Determines when the summary values are calculated * * * Valid values: @@ -268,74 +268,74 @@ interface DataSourceSettingsSummaries { summaryExecution?: string; /** - * A list of column settings that specifies custom summaries options per column basis + * A list of column settings that specifies custom summaries options per column basis * */ columnSettings?: any[]; /** - * Option for DataSourceSettingsSummaries + * Option for DataSourceSettingsSummaries */ [optionName: string]: any; } interface DataSourceSettings { /** - * Setting this is only necessary when the data source is set to a table in string format. we need to create an invisible dummy data container in the body and append the table data to it + * Setting this is only necessary when the data source is set to a table in string format. we need to create an invisible dummy data container in the body and append the table data to it * */ id?: string; /** - * This is the property in the dataView where actual resulting records will be put. (So the dataView will not be array but an object if this is defined), after the potential data source transformation + * This is the property in the dataView where actual resulting records will be put. (So the dataView will not be array but an object if this is defined), after the potential data source transformation * */ outputResultsName?: string; /** - * Callback function to call when data binding is complete + * Callback function to call when data binding is complete * */ callback?: Function; /** - * Object on which to invoke the callback function + * Object on which to invoke the callback function * */ callee?: any; /** - * This is the normalized (transformed) resulting data, after it's fetched from the data source + * This is the normalized (transformed) resulting data, after it's fetched from the data source * */ data?: any[]; /** - * This is the source of data - non normalized. Can be an array, can be reference to some JSON object, can be a DOM element for a HTML TABLE, or a function + * This is the source of data - non normalized. Can be an array, can be reference to some JSON object, can be a DOM element for a HTML TABLE, or a function * */ dataSource?: any; /** - * Client-side dataBinding event. Can be a string pointing to a function name, or an object pointing to a function + * Client-side dataBinding event. Can be a string pointing to a function name, or an object pointing to a function * */ dataBinding?: any; /** - * Client-side dataBound event. Can be a string pointing to a function name, or an object pointing to a function + * Client-side dataBound event. Can be a string pointing to a function name, or an object pointing to a function * */ dataBound?: any; /** - * Specifies the HTTP verb to be used to issue the request + * Specifies the HTTP verb to be used to issue the request * */ requestType?: string; /** - * Type of the data source + * Type of the data source * * * Valid values: @@ -356,31 +356,31 @@ interface DataSourceSettings { type?: string; /** - * A schema object that defines which fields from the data to bind to + * A schema object that defines which fields from the data to bind to * */ schema?: any; /** - * The unique field identifier + * The unique field identifier * */ primaryKey?: string; /** - * Property in the response which specifies the total number of records in the backend (this is needed for paging) + * Property in the response which specifies the total number of records in the backend (this is needed for paging) * */ responseTotalRecCountKey?: string; /** - * Property in the response which specifies where the data records array will be held (if the response is wrapped) + * Property in the response which specifies where the data records array will be held (if the response is wrapped) * */ responseDataKey?: string; /** - * Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType + * Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType * * * Valid values: @@ -394,61 +394,61 @@ interface DataSourceSettings { responseDataType?: string; /** - * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType * */ responseContentType?: string; /** - * If set to false will disable transformations on schema, even if it is defined locally in the javascript code + * If set to false will disable transformations on schema, even if it is defined locally in the javascript code * */ localSchemaTransform?: boolean; /** - * Event that is fired before URL parameters are encoded. Can point to a function name or the function object itself + * Event that is fired before URL parameters are encoded. Can point to a function name or the function object itself * */ urlParamsEncoding?: any; /** - * Event that is fired after URL parameters are encoded (When a remote request is done). Can point to a function name or the function object itself + * Event that is fired after URL parameters are encoded (When a remote request is done). Can point to a function name or the function object itself * */ urlParamsEncoded?: any; /** - * Settings related to built-in paging functionality + * Settings related to built-in paging functionality * */ paging?: DataSourceSettingsPaging; /** - * Settings related to built-in filtering functionality + * Settings related to built-in filtering functionality * */ filtering?: DataSourceSettingsFiltering; /** - * Settings related to built-in sorting functionality + * Settings related to built-in sorting functionality * */ sorting?: DataSourceSettingsSorting; /** - * Settings related to built-in group by functionality + * Settings related to built-in group by functionality * */ groupby?: DataSourceSettingsGroupby; /** - * Settings related to built-in summaries functionality + * Settings related to built-in summaries functionality * */ summaries?: DataSourceSettingsSummaries; /** - * *** IMPORTANT DEPRECATED *** + * *** IMPORTANT DEPRECATED *** * A list of field definitions specifying the schema of the data source. * Field objects description: {name, [type], [xpath]} * @@ -456,13 +456,13 @@ interface DataSourceSettings { fields?: any[]; /** - * If true, will serialize the transaction log of updated values - if any - whenever commit is performed via a remote request. + * If true, will serialize the transaction log of updated values - if any - whenever commit is performed via a remote request. * */ serializeTransactionLog?: boolean; /** - * If set to true, the following behavior will take place: + * If set to true, the following behavior will take place: * if a new row is added, and then deleted, there will be no transaction added to the log * if an edit is made to a row or cell, then the value is brought back to its original value, the transaction should be removed * Note: This option takes effect only when autoCommit is set to false. @@ -471,19 +471,19 @@ interface DataSourceSettings { aggregateTransactions?: boolean; /** - * If auto commit is true, data will be automatically commited to the data source, once a value or a batch of values are updated via saveChanges() + * If auto commit is true, data will be automatically commited to the data source, once a value or a batch of values are updated via saveChanges() * */ autoCommit?: boolean; /** - * Specifies an update remote URL, to which an AJAX request will be made as soon as saveChages() is called. + * Specifies an update remote URL, to which an AJAX request will be made as soon as saveChages() is called. * */ updateUrl?: string; /** - * A function to call when row is added. + * A function to call when row is added. * Function takes first argument item and second argument dataSource. * Use item.row to obtain reference to the added row. * Use item.rowId to get the row ID. @@ -493,7 +493,7 @@ interface DataSourceSettings { rowAdded?: Function; /** - * A function to call when row is updated (edited). + * A function to call when row is updated (edited). * Function takes first argument item and second argument dataSource. * Use item.rowIndex to get the row index. * Use item.newRow to obtain reference to the updated row. @@ -504,7 +504,7 @@ interface DataSourceSettings { rowUpdated?: Function; /** - * A function to call when row is inserted. + * A function to call when row is inserted. * Function takes first argument item and second argument dataSource. * Use item.row to obtain reference to the inserted row. * Use item.rowId to get the row ID. @@ -515,7 +515,7 @@ interface DataSourceSettings { rowInserted?: Function; /** - * A function to call when row is deleted. + * A function to call when row is deleted. * Use item.row to obtain reference to the deleted row. * Use item.rowId to get the row ID. * Use item.rowIndex to get the row index. @@ -525,7 +525,7 @@ interface DataSourceSettings { rowDeleted?: Function; /** - * Option for DataSourceSettings + * Option for DataSourceSettings */ [optionName: string]: any; } @@ -558,9 +558,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -754,20 +754,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -784,9 +784,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -800,11 +800,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -818,12 +818,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -839,10 +839,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -1005,12 +1005,12 @@ declare namespace Infragistics { interface DataSchemaSchemaFields { /** - * Name of the field + * Name of the field */ name?: string; /** - * data type of the fieldstring + * data type of the fieldstring * number * bool * date @@ -1020,40 +1020,40 @@ interface DataSchemaSchemaFields { type?: string|number|boolean|Date|Object; /** - * The XPath expression to map the node to the field + * The XPath expression to map the node to the field */ xpath?: string; /** - * This option is applicable only for fields with fieldDataType="object". Reference to a function (string or function) that can be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this field. + * This option is applicable only for fields with fieldDataType="object". Reference to a function (string or function) that can be used for complex data extraction from the data records, whose return value will be used for all data operations associated with this field. */ mapper?: string|Function; /** - * Option for DataSchemaSchemaFields + * Option for DataSchemaSchemaFields */ [optionName: string]: any; } interface DataSchemaSchema { /** - * A list of field definitions specifying the schema of the data source. Field objects description: {name, [type], [xpath]} + * A list of field definitions specifying the schema of the data source. Field objects description: {name, [type], [xpath]} * returnType="array" */ fields?: DataSchemaSchemaFields; /** - * This is the property (path) in the data source where the records are located. + * This is the property (path) in the data source where the records are located. */ searchField?: string; /** - * This is the property in the resulting object where actual resulting records will be put. (So the result will not be array but an object if this is defined), after the potential data source transformation + * This is the property in the resulting object where actual resulting records will be put. (So the result will not be array but an object if this is defined), after the potential data source transformation */ outputResultsName?: string; /** - * Option for DataSchemaSchema + * Option for DataSchemaSchema */ [optionName: string]: any; } @@ -1085,7 +1085,7 @@ declare namespace Infragistics { /** * A list of field definitions specifying the schema of the data source. - * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} + * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} */ fields(): any[]; } @@ -1122,9 +1122,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -1318,20 +1318,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -1348,9 +1348,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -1364,11 +1364,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -1382,12 +1382,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -1403,10 +1403,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -1575,9 +1575,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -1771,20 +1771,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -1801,9 +1801,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -1817,11 +1817,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -1835,12 +1835,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -1856,10 +1856,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -2002,115 +2002,115 @@ JSONDataSource: typeof Infragistics.JSONDataSource; interface RESTDataSourceSettingsRestSettingsCreate { /** - * Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + * Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ url?: string; /** - * Specifies a remote URL template. Use ${id} in place of the resource id. + * Specifies a remote URL template. Use ${id} in place of the resource id. */ template?: string; /** - * Specifies whether create requests will be sent in batches + * Specifies whether create requests will be sent in batches */ batch?: boolean; /** - * Option for RESTDataSourceSettingsRestSettingsCreate + * Option for RESTDataSourceSettingsRestSettingsCreate */ [optionName: string]: any; } interface RESTDataSourceSettingsRestSettingsUpdate { /** - * Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + * Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ url?: string; /** - * Specifies a remote URL template. Use ${id} in place of the resource id. + * Specifies a remote URL template. Use ${id} in place of the resource id. */ template?: string; /** - * Specifies whether update requests will be sent in batches + * Specifies whether update requests will be sent in batches */ batch?: boolean; /** - * Option for RESTDataSourceSettingsRestSettingsUpdate + * Option for RESTDataSourceSettingsRestSettingsUpdate */ [optionName: string]: any; } interface RESTDataSourceSettingsRestSettingsRemove { /** - * Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. + * Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ url?: string; /** - * Specifies a remote URL template. Use ${id} in place of the resource id. + * Specifies a remote URL template. Use ${id} in place of the resource id. */ template?: string; /** - * Specifies whether update requests will be sent in batches + * Specifies whether update requests will be sent in batches */ batch?: boolean; /** - * Option for RESTDataSourceSettingsRestSettingsRemove + * Option for RESTDataSourceSettingsRestSettingsRemove */ [optionName: string]: any; } interface RESTDataSourceSettingsRestSettings { /** - * Settings for create requests + * Settings for create requests */ create?: RESTDataSourceSettingsRestSettingsCreate; /** - * Settings for update requests + * Settings for update requests */ update?: RESTDataSourceSettingsRestSettingsUpdate; /** - * Settings for remove requests + * Settings for remove requests */ remove?: RESTDataSourceSettingsRestSettingsRemove; /** - * Specifies whether the ids of the removed resources are send through the request URI + * Specifies whether the ids of the removed resources are send through the request URI */ encodeRemoveInRequestUri?: boolean; /** - * Specifies a custom function to serialize content sent to the server. It should accept a single object or an array of objects and return a string. If not specified, JSON.stringify() will be used. + * Specifies a custom function to serialize content sent to the server. It should accept a single object or an array of objects and return a string. If not specified, JSON.stringify() will be used. */ contentSerializer?: Function; /** - * Specifies the content type of the request + * Specifies the content type of the request */ contentType?: string; /** - * Option for RESTDataSourceSettingsRestSettings + * Option for RESTDataSourceSettingsRestSettings */ [optionName: string]: any; } interface RESTDataSourceSettings { /** - * Settings related to REST compliant update routine + * Settings related to REST compliant update routine */ restSettings?: RESTDataSourceSettingsRestSettings; /** - * Option for RESTDataSourceSettings + * Option for RESTDataSourceSettings */ [optionName: string]: any; } @@ -2151,9 +2151,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -2339,20 +2339,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -2369,9 +2369,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -2385,11 +2385,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -2403,12 +2403,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -2424,10 +2424,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -2570,18 +2570,18 @@ RESTDataSource: typeof Infragistics.RESTDataSource; interface JSONPDataSourceSettings { /** - * Override the callback function name in a jsonp request. Sets option jsonp in $.ajax functionbool Setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation + * Override the callback function name in a jsonp request. Sets option jsonp in $.ajax functionbool Setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation * */ jsonp?: string|boolean; /** - * Specify the callback function name for a JSONP request. Sets option jsonpCallback in $.ajax function + * Specify the callback function name for a JSONP request. Sets option jsonpCallback in $.ajax function */ jsonpCallback?: string|Function; /** - * Option for JSONPDataSourceSettings + * Option for JSONPDataSourceSettings */ [optionName: string]: any; } @@ -2614,9 +2614,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -2810,20 +2810,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -2840,9 +2840,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -2856,11 +2856,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -2874,12 +2874,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -2895,10 +2895,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -3067,9 +3067,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -3263,20 +3263,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -3293,9 +3293,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -3309,11 +3309,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -3327,12 +3327,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -3348,10 +3348,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -3520,9 +3520,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -3716,20 +3716,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -3746,9 +3746,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -3762,11 +3762,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -3780,12 +3780,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -3801,10 +3801,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -3973,9 +3973,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -4169,20 +4169,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -4199,9 +4199,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -4215,11 +4215,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -4233,12 +4233,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -4254,10 +4254,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -4426,9 +4426,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -4622,20 +4622,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -4652,9 +4652,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -4668,11 +4668,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -4686,12 +4686,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -4707,10 +4707,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -4853,17 +4853,17 @@ ArrayDataSource: typeof Infragistics.ArrayDataSource; interface MashupDataSourceMashupSettings { /** - * Indicates whether to ignore records that have no corresponding data in all of the provided data sources. + * Indicates whether to ignore records that have no corresponding data in all of the provided data sources. */ ignorePartialRecords?: boolean; /** - * An array of $.ig.DataSource instances holding the disperse data. + * An array of $.ig.DataSource instances holding the disperse data. */ dataSource?: any[]; /** - * Option for MashupDataSourceMashupSettings + * Option for MashupDataSourceMashupSettings */ [optionName: string]: any; } @@ -4941,9 +4941,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -5106,9 +5106,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -5122,11 +5122,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -5140,12 +5140,12 @@ declare namespace Infragistics { /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -5161,10 +5161,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -5307,28 +5307,28 @@ MashupDataSource: typeof Infragistics.MashupDataSource; interface HierarchicalDataSourceSettingsPaging { /** - * Option for HierarchicalDataSourceSettingsPaging + * Option for HierarchicalDataSourceSettingsPaging */ [optionName: string]: any; } interface HierarchicalDataSourceSettingsSorting { /** - * Option for HierarchicalDataSourceSettingsSorting + * Option for HierarchicalDataSourceSettingsSorting */ [optionName: string]: any; } interface HierarchicalDataSourceSettingsFiltering { /** - * Option for HierarchicalDataSourceSettingsFiltering + * Option for HierarchicalDataSourceSettingsFiltering */ [optionName: string]: any; } interface HierarchicalDataSourceSettingsSchema { /** - * Option for HierarchicalDataSourceSettingsSchema + * Option for HierarchicalDataSourceSettingsSchema */ [optionName: string]: any; } @@ -5346,7 +5346,7 @@ interface HierarchicalDataSourceSettings { dataBound?: any; /** - * Other options + * Other options */ type?: string; responseDataType?: any; @@ -5361,13 +5361,13 @@ interface HierarchicalDataSourceSettings { filtering?: HierarchicalDataSourceSettingsFiltering; /** - * All of the rest - paging, sorting, filtering, can be defined in the layouts definition, which will "override" the parent defs + * All of the rest - paging, sorting, filtering, can be defined in the layouts definition, which will "override" the parent defs * IMPORTANT: if there is no paging, sorting or filtering, an instance of $.ig.DataSource won't be created for child row islands */ schema?: HierarchicalDataSourceSettingsSchema; /** - * Option for HierarchicalDataSourceSettings + * Option for HierarchicalDataSourceSettings */ [optionName: string]: any; } @@ -5386,51 +5386,51 @@ HierarchicalDataSource: typeof Infragistics.HierarchicalDataSource; interface TreeHierarchicalDataSourceSettingsTreeDSFiltering { /** - * Specifies from which data bound level to be applied filtering - 0 is the first level + * Specifies from which data bound level to be applied filtering - 0 is the first level */ fromLevel?: number; /** - * Specifies to which data bound level to be applied filtering - if -1 filtering should be applied to the last data bound level + * Specifies to which data bound level to be applied filtering - if -1 filtering should be applied to the last data bound level */ toLevel?: number; /** - * If displayMode is showWithAncestorsAndDescendants, show all records that match filtering conditions and their child records, even if child records don't match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don't match filtering conditions + * If displayMode is showWithAncestorsAndDescendants, show all records that match filtering conditions and their child records, even if child records don't match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don't match filtering conditions */ displayMode?: any; /** - * Filtering data source specific property - name of property in dataRecord object - indicates whether dataRow matches filtering conditions. It is used ONLY when filtering is applied. + * Filtering data source specific property - name of property in dataRecord object - indicates whether dataRow matches filtering conditions. It is used ONLY when filtering is applied. */ matchFiltering?: string; /** - * Option for TreeHierarchicalDataSourceSettingsTreeDSFiltering + * Option for TreeHierarchicalDataSourceSettingsTreeDSFiltering */ [optionName: string]: any; } interface TreeHierarchicalDataSourceSettingsTreeDSSorting { /** - * Specifies from which data bound level to be applied sorting - 0 is the first level + * Specifies from which data bound level to be applied sorting - 0 is the first level */ fromLevel?: number; /** - * Specifies to which data bound level to be applied sorting - if -1 sorting should be applied to the last data bound level + * Specifies to which data bound level to be applied sorting - if -1 sorting should be applied to the last data bound level */ toLevel?: number; /** - * Option for TreeHierarchicalDataSourceSettingsTreeDSSorting + * Option for TreeHierarchicalDataSourceSettingsTreeDSSorting */ [optionName: string]: any; } interface TreeHierarchicalDataSourceSettingsTreeDSPaging { /** - * Sets gets paging mode. + * Sets gets paging mode. * * Valid values: * "allLevels" includes all visible records in paging. @@ -5438,7 +5438,7 @@ interface TreeHierarchicalDataSourceSettingsTreeDSPaging { mode?: string; /** - * When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row. When mode option is 'rootLevelOnly' then the context row always shows the value of the contextRowRootText option. + * When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row. When mode option is 'rootLevelOnly' then the context row always shows the value of the contextRowRootText option. * * * Valid values: @@ -5449,109 +5449,109 @@ interface TreeHierarchicalDataSourceSettingsTreeDSPaging { contextRowMode?: string; /** - * Option for TreeHierarchicalDataSourceSettingsTreeDSPaging + * Option for TreeHierarchicalDataSourceSettingsTreeDSPaging */ [optionName: string]: any; } interface TreeHierarchicalDataSourceSettingsTreeDS { /** - * Property name of the array of child data in a hierarchical data source. + * Property name of the array of child data in a hierarchical data source. */ childDataKey?: string; /** - * Unique identifier used in a self-referencing flat data source. Used with primaryKey to create a relationship among flat data sources. + * Unique identifier used in a self-referencing flat data source. Used with primaryKey to create a relationship among flat data sources. */ foreignKey?: string; /** - * Specifies the depth down to which the tree grid would be expanded upon initial render. To expand all rows set value to -1. Default is -1. + * Specifies the depth down to which the tree grid would be expanded upon initial render. To expand all rows set value to -1. Default is -1. */ initialExpandDepth?: number; /** - * Specifies if data is loaded on demand from a remote server. Default is false. + * Specifies if data is loaded on demand from a remote server. Default is false. */ enableRemoteLoadOnDemand?: boolean; /** - * Specifies a remote URL as a data source, from which data will be retrieved using an AJAX call ($.ajax) + * Specifies a remote URL as a data source, from which data will be retrieved using an AJAX call ($.ajax) */ dataSourceUrl?: string; /** - * Specifies a custom function to be called when the remote request for data has finished. + * Specifies a custom function to be called when the remote request for data has finished. */ requestDataCallback?: Function; /** - * Specifies a custom function to be called when the remote request for data has finished successfully. + * Specifies a custom function to be called when the remote request for data has finished successfully. */ requestDataSuccessCallback?: Function; /** - * Specifies a custom function to be called when the remote request for data has finished with an error. + * Specifies a custom function to be called when the remote request for data has finished with an error. */ requestDataErrorCallback?: Function; /** - * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. + * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. */ propertyExpanded?: string; /** - * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. + * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. */ propertyDataLevel?: string; /** - * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) + * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) * */ initialFlatDataView?: boolean; /** - * Specifies a custom function to be called when requesting data to the server - usually when expanding/collapsing record. If set the function should return the encoded URL. It takes as parameters: data record(type: object), expand - (type: bool). + * Specifies a custom function to be called when requesting data to the server - usually when expanding/collapsing record. If set the function should return the encoded URL. It takes as parameters: data record(type: object), expand - (type: bool). * */ customEncodeUrlFunc?: Function; /** - * If true save expansion states in internal list and send it to the server. Applying to one of the main constraint of the REST architecture Stateless Interactions - client specific data(like expansion states) should NOT be stored on the server + * If true save expansion states in internal list and send it to the server. Applying to one of the main constraint of the REST architecture Stateless Interactions - client specific data(like expansion states) should NOT be stored on the server * */ persistExpansionStates?: boolean; /** - * Configure datasource filtering settings. + * Configure datasource filtering settings. */ filtering?: TreeHierarchicalDataSourceSettingsTreeDSFiltering; /** - * Configure datasource sorting settings. + * Configure datasource sorting settings. */ sorting?: TreeHierarchicalDataSourceSettingsTreeDSSorting; /** - * Configure datasource paging settings. + * Configure datasource paging settings. */ paging?: TreeHierarchicalDataSourceSettingsTreeDSPaging; /** - * Option for TreeHierarchicalDataSourceSettingsTreeDS + * Option for TreeHierarchicalDataSourceSettingsTreeDS */ [optionName: string]: any; } interface TreeHierarchicalDataSourceSettings { /** - * Configure tree datasource specific settings + * Configure tree datasource specific settings */ treeDS?: TreeHierarchicalDataSourceSettingsTreeDS; /** - * Option for TreeHierarchicalDataSourceSettings + * Option for TreeHierarchicalDataSourceSettings */ [optionName: string]: any; } @@ -5562,20 +5562,20 @@ declare namespace Infragistics { /** * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event * * @param callback callback function * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context @@ -5628,7 +5628,7 @@ declare namespace Infragistics { /** * Generates flat data. - * Returns an object that contains the generated flat data, the flat visible data, records count and visible records count. + * Returns an object that contains the generated flat data, the flat visible data, records count and visible records count. * * @param data The data record whose data is transformed. * @param level The level from which to start recursively generating the flat data. If not set defaults to 0. @@ -5695,11 +5695,11 @@ declare namespace Infragistics { /** * Sorts the data source locally. The result (sorted data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param fields an array of fields object definitions * @param direction asc / desc direction @@ -5708,9 +5708,9 @@ declare namespace Infragistics { /** * Sorts the given data recursively - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] * * @param data the data array that will be sorted. * @param level the level to which the data belongs to @@ -5723,14 +5723,14 @@ declare namespace Infragistics { * Sorts the passed data and returns the sorted result. * * @param data the data to be sorted - - fields => an array of fields object definitions: - example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ + * + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ sortData(data: Object, fields: Object, direction: string): void; /** @@ -5745,18 +5745,18 @@ declare namespace Infragistics { /** * Returns the total number of match filtering records in the data source. - * When the dataSource is remote and filtering is applied then it is taken value - * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount + * When the dataSource is remote and filtering is applied then it is taken value + * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount */ getFilteringMatchRecordsCount(): number; /** * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped * * @param fieldExpressions a list of field expression definitions * @param boolLogic boolean logic. Accepted values are AND and OR. @@ -5867,9 +5867,9 @@ declare namespace Infragistics { /** * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging * * @param transformedExecution */ @@ -6035,9 +6035,9 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) * * @param key response key to take summary data(for example "Metadata.Summaries") * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) @@ -6056,10 +6056,10 @@ declare namespace Infragistics { /** * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client * * @param count the total number of records * @param key @@ -6206,7 +6206,7 @@ interface SimpleTextMarkerTemplateSettings { font?: any; /** - * Option for SimpleTextMarkerTemplateSettings + * Option for SimpleTextMarkerTemplateSettings */ [optionName: string]: any; } @@ -6226,7 +6226,7 @@ SimpleTextMarkerTemplate: typeof Infragistics.SimpleTextMarkerTemplate; interface GridExcelExporterSettingsGridFeatureOptions { /** - * Indicates whether sorting will be applied in the exported table. This is set_ to none by default, but will change to applied if sorting feature is defined in the igGrid. + * Indicates whether sorting will be applied in the exported table. This is set_ to none by default, but will change to applied if sorting feature is defined in the igGrid. * * Valid values: * "none" No sorting will be applied in the excel document. @@ -6235,7 +6235,7 @@ interface GridExcelExporterSettingsGridFeatureOptions { sorting?: string; /** - * Indicates whether the rows on the current page or entire data will exported. + * Indicates whether the rows on the current page or entire data will exported. * * Valid values: * "currentPage" Only current page will be exported to the excel document. @@ -6244,7 +6244,7 @@ interface GridExcelExporterSettingsGridFeatureOptions { paging?: string; /** - * Indicates whether hidden columns will be removed from the exported table. This is set to none by default, but will change to applied if hiding feature is defined in the igGrid. + * Indicates whether hidden columns will be removed from the exported table. This is set to none by default, but will change to applied if hiding feature is defined in the igGrid. * * Valid values: * "none" All hidden columns will be exported to the excel document. @@ -6254,7 +6254,7 @@ interface GridExcelExporterSettingsGridFeatureOptions { hiding?: string; /** - * Indicates whether filtering will be applied in the exported table. this is set to none by default, but will change to applied if filtering feature is defined in the igGrid. + * Indicates whether filtering will be applied in the exported table. this is set to none by default, but will change to applied if filtering feature is defined in the igGrid. * * Valid values: * "none" No filtering will be applied in the excel document. @@ -6264,7 +6264,7 @@ interface GridExcelExporterSettingsGridFeatureOptions { filtering?: string; /** - * Indicates whether fixed columns will be applied in the exported table. This is set to none by default, but will change to applied if column fixing feature is defined in the igGrid. + * Indicates whether fixed columns will be applied in the exported table. This is set to none by default, but will change to applied if column fixing feature is defined in the igGrid. * * Valid values: * "none" No column fixing will be applied in the excel document. @@ -6273,7 +6273,7 @@ interface GridExcelExporterSettingsGridFeatureOptions { columnfixing?: string; /** - * Indicates whether summaries will be added in the exported table. This is set to none by default, but will change to applied if summaries feature is defined in the igGrid. + * Indicates whether summaries will be added in the exported table. This is set to none by default, but will change to applied if summaries feature is defined in the igGrid. * * Valid values: * "none" No summaries will be exported to the excel document. @@ -6282,39 +6282,39 @@ interface GridExcelExporterSettingsGridFeatureOptions { summaries?: string; /** - * Option for GridExcelExporterSettingsGridFeatureOptions + * Option for GridExcelExporterSettingsGridFeatureOptions */ [optionName: string]: any; } interface GridExcelExporterSettings { /** - * Specifies the name of the excel file that will be generated. + * Specifies the name of the excel file that will be generated. */ fileName?: string; /** - * List of export settings which can be used with Grid Excel exporter + * List of export settings which can be used with Grid Excel exporter */ gridFeatureOptions?: GridExcelExporterSettingsGridFeatureOptions; /** - * Specifies the name of workbook where the igGrid will be exported. + * Specifies the name of workbook where the igGrid will be exported. */ worksheetName?: string; /** - * List of strings containing the keys for the worksheet columns which will not be applied any filtering + * List of strings containing the keys for the worksheet columns which will not be applied any filtering */ skipFilteringOn?: any[]; /** - * List of strings containing the keys for the columns that will not be exported + * List of strings containing the keys for the columns that will not be exported */ columnsToSkip?: any[]; /** - * Specifies the excel table style region. + * Specifies the excel table style region. * You can set the following table style * TableStyleMedium[1-28] * TableStyleLight[1-21] @@ -6323,7 +6323,7 @@ interface GridExcelExporterSettings { tableStyle?: string; /** - * Indicates whether excel table styles will be the same as grid styles. This is set to applied by default. Custom grid themes are not supported. + * Indicates whether excel table styles will be the same as grid styles. This is set to applied by default. Custom grid themes are not supported. * * Valid values: * "none" The styles from the grid are not applied to the table region. @@ -6332,7 +6332,7 @@ interface GridExcelExporterSettings { gridStyling?: string; /** - * Indicates whether all sublevel data will be exported, or only data under expanded rows. + * Indicates whether all sublevel data will be exported, or only data under expanded rows. * * Valid values: * "allRows" All sublevel data will be exported. @@ -6341,21 +6341,21 @@ interface GridExcelExporterSettings { dataExportMode?: string; /** - * Option for GridExcelExporterSettings + * Option for GridExcelExporterSettings */ [optionName: string]: any; } interface GridExcelExporterCallbacks { /** - * Cancel="true" Callback fired when the exporting has started. + * Cancel="true" Callback fired when the exporting has started. * Function takes arguments sender and args. * Use args.grid to get reference to igGrid widget. */ exportStarting?: any; /** - * Cancel="true" Callback fired when cell exporting has begin. + * Cancel="true" Callback fired when cell exporting has begin. * Function takes arguments sender and args. * Use args.columnKey to get the igGrid column key of the cell. * Use args.columnIndex to get the igGrid column index of the cell. @@ -6367,7 +6367,7 @@ interface GridExcelExporterCallbacks { cellExporting?: any; /** - * Callback fired when cell exporting has end. + * Callback fired when cell exporting has end. * Function takes arguments sender and args. * Use args.columnKey to get the igGrid column key of the cell. * Use args.columnIndex to get the igGrid column index of the cell. @@ -6379,7 +6379,7 @@ interface GridExcelExporterCallbacks { cellExported?: any; /** - * Cancel="true" Callback fired when header cell exporting has begin. + * Cancel="true" Callback fired when header cell exporting has begin. * Function takes arguments sender and args. * Use args.headerText to get or set the igGrid column key of the header cell. * Use args.columnKey to get the igGrid column key of the header cell. @@ -6388,7 +6388,7 @@ interface GridExcelExporterCallbacks { headerCellExporting?: any; /** - * Callback fired when header cell exporting has end. + * Callback fired when header cell exporting has end. * Function takes arguments sender and args. * Use args.headerText to get the igGrid column key of the header cell. * Use args.columnKey to get the igGrid column key of the header cell. @@ -6397,7 +6397,7 @@ interface GridExcelExporterCallbacks { headerCellExported?: any; /** - * Cancel="true" Callback fired when row exporting has begin. + * Cancel="true" Callback fired when row exporting has begin. * Function takes arguments sender and args. * Use args.rowId to get key or index of row. * Use args.element to get row TR element. @@ -6408,7 +6408,7 @@ interface GridExcelExporterCallbacks { rowExporting?: any; /** - * Cancel="true" Callback fired when row exporting has ended. + * Cancel="true" Callback fired when row exporting has ended. * Function takes arguments sender and args. * Use args.rowId to get key or index of row. * Use args.element to get row TR element. @@ -6419,7 +6419,7 @@ interface GridExcelExporterCallbacks { rowExported?: any; /** - * Cancel="true" Callback fired when summary exporting has begun. + * Cancel="true" Callback fired when summary exporting has begun. * Function takes arguments sender and args. * Use args.headerText to get the igGrid column header text. * Use args.columnKey to get the igGrid column key. @@ -6430,7 +6430,7 @@ interface GridExcelExporterCallbacks { summaryExporting?: any; /** - * Callback fired when cell exporting has end. + * Callback fired when cell exporting has end. * Function takes arguments sender and args. * Use args.headerText to get the igGrid column header text. * Use args.columnKey to get the igGrid column key. @@ -6441,7 +6441,7 @@ interface GridExcelExporterCallbacks { summaryExported?: any; /** - * Cancel="true" Callback fired when export is ending, but the document is not saved. + * Cancel="true" Callback fired when export is ending, but the document is not saved. * Function takes arguments sender and args. * Use args.grid to get reference to the igGrid widget. * Use args.workbook to get reference to the excel workbook. @@ -6450,19 +6450,19 @@ interface GridExcelExporterCallbacks { exportEnding?: any; /** - * Callback fired when exporting is successful. + * Callback fired when exporting is successful. * Use data to get the reference of saved object. */ success?: any; /** - * Callback fired when exporting is failed. + * Callback fired when exporting is failed. * Use error to get the reference of error object. */ error?: any; /** - * Option for GridExcelExporterCallbacks + * Option for GridExcelExporterCallbacks */ [optionName: string]: any; } @@ -6488,130 +6488,130 @@ GridExcelExporter: typeof Infragistics.GridExcelExporter; interface OlapXmlaDataSourceOptionsRequestOptions { /** - * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. + * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest * and will prompt the user for credentials. */ withCredentials?: boolean; /** - * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax's options object. + * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax's options object. */ beforeSend?: Function; /** - * Option for OlapXmlaDataSourceOptionsRequestOptions + * Option for OlapXmlaDataSourceOptionsRequestOptions */ [optionName: string]: any; } interface OlapXmlaDataSourceOptionsMdxSettings { /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ nonEmptyOnRows?: boolean; /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true */ nonEmptyOnColumns?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnRows?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnColumns?: boolean; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnRows?: any[]; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnColumns?: any[]; /** - * Option for OlapXmlaDataSourceOptionsMdxSettings + * Option for OlapXmlaDataSourceOptionsMdxSettings */ [optionName: string]: any; } interface OlapXmlaDataSourceOptions { /** - * Optional="false" The URL of the XMLA server. + * Optional="false" The URL of the XMLA server. */ serverUrl?: string; /** - * The catalog name. + * The catalog name. */ catalog?: string; /** - * The name of the cube in the data source. + * The name of the cube in the data source. */ cube?: string; /** - * The name of the measure group in the data source. + * The name of the measure group in the data source. */ measureGroup?: string; /** - * A list of measure names separated by comma (,). These will be the measures of the data source. + * A list of measure names separated by comma (,). These will be the measures of the data source. */ measures?: string; /** - * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. + * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. */ filters?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. */ rows?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. */ columns?: string; /** - * An object containing information about how the request to the XMLA server should be processed. + * An object containing information about how the request to the XMLA server should be processed. */ requestOptions?: OlapXmlaDataSourceOptionsRequestOptions; /** - * Enables/disables caching of the XMLA result object. + * Enables/disables caching of the XMLA result object. */ enableResultCache?: boolean; /** - * Additional properties sent with every discover request. + * Additional properties sent with every discover request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ discoverProperties?: any; /** - * Additional properties sent with every execute request. + * Additional properties sent with every execute request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ executeProperties?: any; /** - * Optional="true" a javascript object containing information about how the request to the xmla server should be processed + * Optional="true" a javascript object containing information about how the request to the xmla server should be processed */ mdxSettings?: OlapXmlaDataSourceOptionsMdxSettings; /** - * Option for OlapXmlaDataSourceOptions + * Option for OlapXmlaDataSourceOptions */ [optionName: string]: any; } @@ -6933,227 +6933,227 @@ OlapXmlaDataSource: typeof Infragistics.OlapXmlaDataSource; interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure { /** - * Optional="false" A unique name for the measure. + * Optional="false" A unique name for the measure. */ name?: string; /** - * A caption for the measure. + * A caption for the measure. */ caption?: string; /** - * Optional="false" An aggregator function called when each cell is evaluated. + * Optional="false" An aggregator function called when each cell is evaluated. * Returns a value for the cell. If the returned value is null, no cell will be created in for the data source result. */ aggregator?: Function; /** - * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). + * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). */ displayFolder?: string; /** - * Option for OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure + * Option for OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension { /** - * A unique name for the measures dimension. + * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: * [].[] */ name?: string; /** - * A caption for the measures dimension. + * A caption for the measures dimension. * The default value is "Measures". */ caption?: string; /** - * An array of measure metadata objects. + * An array of measure metadata objects. */ measures?: OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure[]; /** - * Option for OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension + * Option for OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel { /** - * Optional="false" A name for the level. + * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: * {}.[] */ name?: string; /** - * A caption for the level. + * A caption for the level. */ caption?: string; /** - * A function called for each item of the data source array when level members are created. + * A function called for each item of the data source array when level members are created. * Based on the item parameter the function should return a value that will form the $.ig.Member’s name and caption. */ memberProvider?: Function; /** - * Option for OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel + * Option for OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { /** - * Optional="false" A name for the hierarchy. + * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: * [].[] */ name?: string; /** - * A caption for the hierarchy. + * A caption for the hierarchy. */ caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. + * The path to be used when displaying the hierarchy in the user interface. * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; /** - * An array of level metadata objects. + * An array of level metadata objects. */ levels?: OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel[]; /** - * Option for OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie + * Option for OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadataCubeDimension { /** - * Optional="false" A unique name for the dimension. + * Optional="false" A unique name for the dimension. */ name?: string; /** - * A caption for the dimension. + * A caption for the dimension. */ caption?: string; /** - * An array of hierarchy metadata objects. + * An array of hierarchy metadata objects. */ hierarchies?: OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie[]; /** - * Option for OlapFlatDataSourceOptionsMetadataCubeDimension + * Option for OlapFlatDataSourceOptionsMetadataCubeDimension */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadataCube { /** - * Optional="false" A unique name for the cube. + * Optional="false" A unique name for the cube. */ name?: string; /** - * A caption for the cube. + * A caption for the cube. */ caption?: string; /** - * An object providing information about the measures' root node. + * An object providing information about the measures' root node. */ measuresDimension?: OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension; /** - * An array of dimension metadata objects. + * An array of dimension metadata objects. */ dimensions?: OlapFlatDataSourceOptionsMetadataCubeDimension[]; /** - * Option for OlapFlatDataSourceOptionsMetadataCube + * Option for OlapFlatDataSourceOptionsMetadataCube */ [optionName: string]: any; } interface OlapFlatDataSourceOptionsMetadata { /** - * Optional="false" Metadata used for the creation of the cube. + * Optional="false" Metadata used for the creation of the cube. */ cube?: OlapFlatDataSourceOptionsMetadataCube; /** - * Option for OlapFlatDataSourceOptionsMetadata + * Option for OlapFlatDataSourceOptionsMetadata */ [optionName: string]: any; } interface OlapFlatDataSourceOptions { /** - * Optional="true" Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Optional="true" Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ dataSource?: any; /** - * Optional="true" Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. + * Optional="true" Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. */ dataSourceUrl?: string; /** - * Optional="true" Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Optional="true" Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * Optional="true" Specifies the name of the property in which data records are held if the response is wrapped. + * Optional="true" Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Optional="true" Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Optional="true" Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ responseDataType?: string; /** - * A list of measure names separated by comma (,). These will be the measures of the data source. + * A list of measure names separated by comma (,). These will be the measures of the data source. */ measures?: string; /** - * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. + * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. */ filters?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. */ rows?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. */ columns?: string; /** - * Optional="false" An object containing processing instructions for the $.ig.DataSource data. + * Optional="false" An object containing processing instructions for the $.ig.DataSource data. */ metadata?: OlapFlatDataSourceOptionsMetadata; /** - * Option for OlapFlatDataSourceOptions + * Option for OlapFlatDataSourceOptions */ [optionName: string]: any; } @@ -7499,27 +7499,27 @@ declare namespace Infragistics { interface OlapResultViewOptions { /** - * Optional="false" an object of type $.ig.OlapResult which represents the full cached result. + * Optional="false" an object of type $.ig.OlapResult which represents the full cached result. */ result?: any; /** - * Optional="false" an object of type $.ig.OlapResult which represents the visible part of the result. + * Optional="false" an object of type $.ig.OlapResult which represents the visible part of the result. */ visibleResult?: any; /** - * Optional="false" a value indicating whether the result has one or more hierarchies in the columns. + * Optional="false" a value indicating whether the result has one or more hierarchies in the columns. */ hasColumns?: boolean; /** - * Optional="false" a value indicating whether the result has one or more hierarchies in the rows. + * Optional="false" a value indicating whether the result has one or more hierarchies in the rows. */ hasRows?: boolean; /** - * Option for OlapResultViewOptions + * Option for OlapResultViewOptions */ [optionName: string]: any; } @@ -7561,7 +7561,7 @@ OlapResultView: typeof Infragistics.OlapResultView; interface OlapTableViewOptionsViewSettings { /** - * Optional="false" a value indicating whether parent for columns is in front of its children. + * Optional="false" a value indicating whether parent for columns is in front of its children. * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. @@ -7569,7 +7569,7 @@ interface OlapTableViewOptionsViewSettings { isParentInFrontForColumns?: boolean; /** - * Optional="false" a value indicating whether parent for rows is in front of its children. + * Optional="false" a value indicating whether parent for rows is in front of its children. * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. @@ -7577,44 +7577,44 @@ interface OlapTableViewOptionsViewSettings { isParentInFrontForRows?: boolean; /** - * Optional="false" value indicating wheter the column headers should be arranged for compact header layout - each hieararchy is in a single row. + * Optional="false" value indicating wheter the column headers should be arranged for compact header layout - each hieararchy is in a single row. */ compactColumnHeaders?: boolean; /** - * Optional="false" value indicating wheter the row headers should be arranged for compact header layout - each hieararchy is in a single row. + * Optional="false" value indicating wheter the row headers should be arranged for compact header layout - each hieararchy is in a single row. */ compactRowHeaders?: boolean; /** - * Option for OlapTableViewOptionsViewSettings + * Option for OlapTableViewOptionsViewSettings */ [optionName: string]: any; } interface OlapTableViewOptions { /** - * Optional="false" an object of type $.ig.OlapResult. + * Optional="false" an object of type $.ig.OlapResult. */ result?: any; /** - * Optional="false" a value indicating whether the result has one or more hierarchies in the columns. + * Optional="false" a value indicating whether the result has one or more hierarchies in the columns. */ hasColumns?: boolean; /** - * Optional="false" a value indicating whether the result has one or more hierarchies in the rows. + * Optional="false" a value indicating whether the result has one or more hierarchies in the rows. */ hasRows?: boolean; /** - * Optional="false" an object containing the table view configuration options as properties. + * Optional="false" an object containing the table view configuration options as properties. */ viewSettings?: OlapTableViewOptionsViewSettings; /** - * Option for OlapTableViewOptions + * Option for OlapTableViewOptions */ [optionName: string]: any; } @@ -8263,17 +8263,17 @@ declare namespace Infragistics { interface OlapResultAxisOptions { /** - * Optional="false" array of $.ig.OlapResultTuple objects which form the axis. + * Optional="false" array of $.ig.OlapResultTuple objects which form the axis. */ tuples?: any[]; /** - * Optional="false" the count of the $.ig.OlapResultAxisMember objects of each tuple. + * Optional="false" the count of the $.ig.OlapResultAxisMember objects of each tuple. */ tupleSize?: number; /** - * Option for OlapResultAxisOptions + * Option for OlapResultAxisOptions */ [optionName: string]: any; } @@ -8299,12 +8299,12 @@ OlapResultAxis: typeof Infragistics.OlapResultAxis; interface OlapResultTupleOptions { /** - * Optional="false" array of $.ig.OlapResultAxisMember objects which form the tuple object. + * Optional="false" array of $.ig.OlapResultAxisMember objects which form the tuple object. */ members?: any[]; /** - * Option for OlapResultTupleOptions + * Option for OlapResultTupleOptions */ [optionName: string]: any; } @@ -8417,7 +8417,7 @@ declare namespace Infragistics { interface IgTemplatingRegExp { /** - * Option for IgTemplatingRegExp + * Option for IgTemplatingRegExp */ [optionName: string]: any; } @@ -8454,12 +8454,12 @@ interface ErrorMessageDisplayingEvent { interface ErrorMessageDisplayingEventUIParam { /** - * Used to obtain reference to the barcode widget. + * Used to obtain reference to the barcode widget. */ owner?: any; /** - * Used to get or set the error message that is to be shown. + * Used to get or set the error message that is to be shown. */ errorMessage?: any; } @@ -8470,69 +8470,69 @@ interface DataChangedEvent { interface DataChangedEventUIParam { /** - * Used to obtain reference to the barcode widget. + * Used to obtain reference to the barcode widget. */ owner?: any; /** - * Used to obtain the new data. + * Used to obtain the new data. */ newData?: any; } interface IgQRCodeBarcode { /** - * The width of the barcode. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the barcode. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Gets or sets the brush to use to fill the backing of the barcode. + * Gets or sets the brush to use to fill the backing of the barcode. */ backingBrush?: string; /** - * Gets or sets the brush to use for the outline of the backing. + * Gets or sets the brush to use for the outline of the backing. */ backingOutline?: string; /** - * Gets or sets the stroke thickness of the backing outline. + * Gets or sets the stroke thickness of the backing outline. */ backingStrokeThickness?: number; /** - * Gets or sets the brush to use to fill the background of the bars. + * Gets or sets the brush to use to fill the background of the bars. */ barBrush?: string; /** - * Gets or sets the brush to use for the label font. + * Gets or sets the brush to use for the label font. */ fontBrush?: string; /** - * Gets or sets the font of the text displayed by the control. + * Gets or sets the font of the text displayed by the control. */ font?: string; /** - * Gets or sets the data value. + * Gets or sets the data value. */ data?: string; /** - * Gets or sets the message text displayed when some error occurs. + * Gets or sets the message text displayed when some error occurs. */ errorMessageText?: string; /** - * Gets or sets the stretch. + * Gets or sets the stretch. * * Valid values: * "none" @@ -8543,7 +8543,7 @@ interface IgQRCodeBarcode { stretch?: string; /** - * Gets or sets a value which specifies how the grid fills within the barcode control dimensions. + * Gets or sets a value which specifies how the grid fills within the barcode control dimensions. * * Valid values: * "fillSpace" FillSpace mode ensures that the barcode grid fills the control dimensions. @@ -8552,17 +8552,17 @@ interface IgQRCodeBarcode { barsFillMode?: string; /** - * Gets or sets the width (XDimension) to height (YDimension) ratio. It accepts only positive values. This property does not apply for the QR barcode. + * Gets or sets the width (XDimension) to height (YDimension) ratio. It accepts only positive values. This property does not apply for the QR barcode. */ widthToHeightRatio?: number; /** - * Gets or sets the X-dimension (narrow element width) for a symbol in mm. It accepts values from 0.01 to 100. + * Gets or sets the X-dimension (narrow element width) for a symbol in mm. It accepts values from 0.01 to 100. */ xDimension?: number; /** - * Gets or sets the error correction level of the QR Code symbol. + * Gets or sets the error correction level of the QR Code symbol. * * Valid values: * "low" Low error correction level allows recovery of 7% of the symbol codewords. @@ -8573,7 +8573,7 @@ interface IgQRCodeBarcode { errorCorrectionLevel?: string; /** - * Gets or sets the size version of the QR Code symbol. + * Gets or sets the size version of the QR Code symbol. * * Valid values: * "undefined" If set, the QR code barcode sets internally the smallest version that will accommodate the data. @@ -8621,7 +8621,7 @@ interface IgQRCodeBarcode { sizeVersion?: string; /** - * Gets or sets the encoding mode for compaction of the QR Code symbol data. The default value is undefined if the Shift_JIS encoding is loaded. Otherwise the default value is byte. + * Gets or sets the encoding mode for compaction of the QR Code symbol data. The default value is undefined if the Shift_JIS encoding is loaded. Otherwise the default value is byte. * * Valid values: * "undefined" When Undefined encoding mode is set, the QR code barcode internally switches between modes as necessary in order to achieve the most efficient conversion of data into a binary string. @@ -8633,13 +8633,13 @@ interface IgQRCodeBarcode { encodingMode?: string; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). */ eciNumber?: number; /** - * Gets or sets a value indicating whether to show the ECI header. + * Gets or sets a value indicating whether to show the ECI header. * * Valid values: * "hide" Hide the header. @@ -8648,7 +8648,7 @@ interface IgQRCodeBarcode { eciHeaderDisplayMode?: string; /** - * Gets or sets the FNC1 mode indicator which identifies symbols encoding messages formatted according to specific predefined industry or application specificatoins. + * Gets or sets the FNC1 mode indicator which identifies symbols encoding messages formatted according to specific predefined industry or application specificatoins. * * Valid values: * "none" Do not use any Fnc1 symbols, i.e. the data is not identified according to specific predefined industry or application specifications. @@ -8658,13 +8658,13 @@ interface IgQRCodeBarcode { fnc1Mode?: string; /** - * Gets or sets the Application Indicator assigned to identify the specification concerned by AIM International. + * Gets or sets the Application Indicator assigned to identify the specification concerned by AIM International. * The value is respected only when the Fnc1Mode is set to Industry. Its value may take the form of any single Latin alphabetic character from the set {a - z, A - Z} or a two-digit number. */ applicationIndicator?: string; /** - * Occurs when an error has happened. + * Occurs when an error has happened. * Function takes first argument evt and second argument ui. * Use ui.owner to obtain reference to the barcode widget. * Use ui.errorMessage to get or set the error message that is to be shown. @@ -8672,7 +8672,7 @@ interface IgQRCodeBarcode { errorMessageDisplaying?: ErrorMessageDisplayingEvent; /** - * Occurs when the data has changed. + * Occurs when the data has changed. * Function takes first argument evt and second argument ui. * Use ui.owner to obtain reference to the barcode widget. * Use ui.newData to obtain the new data. @@ -8680,28 +8680,28 @@ interface IgQRCodeBarcode { dataChanged?: DataChangedEvent; /** - * Option for igQRCodeBarcode + * Option for igQRCodeBarcode */ [optionName: string]: any; } interface IgQRCodeBarcodeMethods { /** - * Returns information about how the barcode is rendered. + * Returns information about how the barcode is rendered. */ exportVisualData(): Object; /** - * Causes all pending changes of the barcode e.g. by changed property values to be rendered immediately. + * Causes all pending changes of the barcode e.g. by changed property values to be rendered immediately. */ flush(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; /** - * Re-polls the css styles for the widget. Use this method when the css styles have been modified. + * Re-polls the css styles for the widget. Use this method when the css styles have been modified. */ styleUpdated(): void; } @@ -9018,12 +9018,12 @@ interface DataBindingEvent { interface DataBindingEventUIParam { /** - * Used to obtain reference to chart widget. + * Used to obtain reference to chart widget. */ owner?: any; /** - * Used to obtain reference to instance of $.ig.DataSource. + * Used to obtain reference to instance of $.ig.DataSource. */ dataSource?: any; } @@ -9034,17 +9034,17 @@ interface DataBoundEvent { interface DataBoundEventUIParam { /** - * Used to obtain reference to chart widget. + * Used to obtain reference to chart widget. */ owner?: any; /** - * Used to obtain reference to array actual data which is displayed by chart. + * Used to obtain reference to array actual data which is displayed by chart. */ data?: any; /** - * Used to obtain reference to instance of $.ig.DataSource. + * Used to obtain reference to instance of $.ig.DataSource. */ dataSource?: any; } @@ -9055,32 +9055,32 @@ interface UpdateTooltipEvent { interface UpdateTooltipEventUIParam { /** - * Used to obtain reference to chart widget. + * Used to obtain reference to chart widget. */ owner?: any; /** - * Used to obtain html of tooltip. Value of that member can be modified. If modified value is null or empty string, then current content of tooltip keeps old value. + * Used to obtain html of tooltip. Value of that member can be modified. If modified value is null or empty string, then current content of tooltip keeps old value. */ text?: any; /** - * Used to obtain reference to item. Value of that member can be modified or replaced by custom item. + * Used to obtain reference to item. Value of that member can be modified or replaced by custom item. */ item?: any; /** - * Used to obtain left position of tooltip in pixels relative to widget. Value of that member can be modified. + * Used to obtain left position of tooltip in pixels relative to widget. Value of that member can be modified. */ x?: any; /** - * Used to obtain top position of tooltip in pixels relative to widget. Value of that member can be modified. + * Used to obtain top position of tooltip in pixels relative to widget. Value of that member can be modified. */ y?: any; /** - * Used to obtain reference to jquery object which represents tooltip. Value of that member can be replaced by custom element. + * Used to obtain reference to jquery object which represents tooltip. Value of that member can be replaced by custom element. */ element?: any; } @@ -9091,72 +9091,72 @@ interface HideTooltipEvent { interface HideTooltipEventUIParam { /** - * Used to obtain reference to chart widget. + * Used to obtain reference to chart widget. */ owner?: any; /** - * Used to obtain reference to item. + * Used to obtain reference to item. */ item?: any; /** - * Used to obtain reference to jquery object which represents tooltip or value of ui.element from last updateTooltip event. Value of that member can be replaced by custom element. + * Used to obtain reference to jquery object which represents tooltip or value of ui.element from last updateTooltip event. Value of that member can be replaced by custom element. */ element?: any; } interface IgBaseChart { /** - * The width of the chart. + * The width of the chart. */ width?: number; /** - * The height of the chart. + * The height of the chart. */ height?: number; /** - * Gets sets template for tooltip associated with chart item. + * Gets sets template for tooltip associated with chart item. * Example: "Value: $(ValueMemberPathInDataSource)" */ tooltipTemplate?: string; /** - * Gets sets maximum number of displayed records in chart. + * Gets sets maximum number of displayed records in chart. */ maxRecCount?: number; /** - * Gets sets a valid data source. + * Gets sets a valid data source. * That can be instance of array or primitives, array of objects, instance of $.ig.DataSource, or any other data accepted by $.ig.DataSource. * Note: if it is set to string and "dataSourceType" option is not set, then $.ig.JSONPDataSource is used. */ dataSource?: any; /** - * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property + * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property */ dataSourceType?: string; /** - * Gets sets url which is used for sending JSON on request for remote data. + * Gets sets url which is used for sending JSON on request for remote data. */ dataSourceUrl?: string; /** - * See $.ig.DataSource. property in the response specifying the total number of records on the server. + * See $.ig.DataSource. property in the response specifying the total number of records on the server. */ responseTotalRecCountKey?: string; /** - * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. + * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. */ responseDataKey?: string; /** - * Event which is raised before data binding. + * Event which is raised before data binding. * Return false in order to cancel data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -9165,7 +9165,7 @@ interface IgBaseChart { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding. + * Event which is raised after data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. * Use ui.data to obtain reference to array actual data which is displayed by chart. @@ -9174,7 +9174,7 @@ interface IgBaseChart { dataBound?: DataBoundEvent; /** - * Event which is raised before tooltip is updated. + * Event which is raised before tooltip is updated. * Return false in order to cancel updating and hide tooltip. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -9187,7 +9187,7 @@ interface IgBaseChart { updateTooltip?: UpdateTooltipEvent; /** - * Event which is raised before tooltip is hidden. + * Event which is raised before tooltip is hidden. * Return false in order to cancel hiding and keep tooltip visible. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -9197,39 +9197,39 @@ interface IgBaseChart { hideTooltip?: HideTooltipEvent; /** - * Option for igBaseChart + * Option for igBaseChart */ [optionName: string]: any; } interface IgBaseChartMethods { /** - * Find index of item within actual data used by chart. + * Find index of item within actual data used by chart. * * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** - * Get item within actual data used by chart. That is similar to this.getData()[ index ]. + * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * * @param index Index of data item. */ getDataItem(index: Object): Object; /** - * Get reference of actual data used by chart. + * Get reference of actual data used by chart. */ getData(): any[]; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -9237,14 +9237,14 @@ interface IgBaseChartMethods { insertItem(item: Object, index: number): Object; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -9252,7 +9252,7 @@ interface IgBaseChartMethods { setItem(index: number, item: Object): Object; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -9262,16 +9262,16 @@ interface IgBaseChartMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -9280,8 +9280,8 @@ interface IgBaseChartMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -9290,17 +9290,17 @@ interface IgBaseChartMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Get reference to chart object. + * Get reference to chart object. */ chart(): Object; /** - * Binds data to the chart + * Binds data to the chart */ dataBind(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; } @@ -9535,61 +9535,61 @@ interface JQuery { } interface IgBulletGraphRange { /** - * Gets or sets the name of the range. + * Gets or sets the name of the range. */ name?: string; /** - * Gets or sets the brush to use to fill the range. + * Gets or sets the brush to use to fill the range. */ brush?: string; /** - * Gets or sets the outline to use when rendering the range. + * Gets or sets the outline to use when rendering the range. */ outline?: string; /** - * Gets or sets the value at which the range starts along the scale. + * Gets or sets the value at which the range starts along the scale. */ startValue?: number; /** - * Gets or sets the value at which the range ends along the scale. + * Gets or sets the value at which the range ends along the scale. */ endValue?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ innerStartExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ innerEndExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ outerStartExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ outerEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering this range's outline. + * Gets or sets the stroke thickness to use when rendering this range's outline. */ strokeThickness?: number; /** - * Option for IgBulletGraphRange + * Option for IgBulletGraphRange */ [optionName: string]: any; } @@ -9610,37 +9610,37 @@ interface AlignLabelEventUIParam { interface IgBulletGraph { /** - * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Gets or sets the scale ranges to render on the bullet graph. + * Gets or sets the scale ranges to render on the bullet graph. */ ranges?: IgBulletGraphRange[]; /** - * Gets or sets the ranges' tooltip template. + * Gets or sets the ranges' tooltip template. */ rangeToolTipTemplate?: string; /** - * Gets or sets the value's tooltip template. + * Gets or sets the value's tooltip template. */ valueToolTipTemplate?: string; /** - * Gets or sets the target value's tooltip template. + * Gets or sets the target value's tooltip template. */ targetValueToolTipTemplate?: string; /** - * Gets or sets the orientation of the scale. + * Gets or sets the orientation of the scale. * * Valid values: * "horizontal" @@ -9649,268 +9649,268 @@ interface IgBulletGraph { orientation?: string; /** - * Gets or sets a collection of brushes to be used as the palette for bullet graph ranges. + * Gets or sets a collection of brushes to be used as the palette for bullet graph ranges. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeBrushes?: any; /** - * Gets or sets a collection of brushes to be used as the palette for bullet graph outlines. + * Gets or sets a collection of brushes to be used as the palette for bullet graph outlines. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeOutlines?: any; /** - * Gets or sets the minimum value of the scale. + * Gets or sets the minimum value of the scale. */ minimumValue?: number; /** - * Gets or sets the maximum value of the scale. + * Gets or sets the maximum value of the scale. */ maximumValue?: number; /** - * Gets or sets the value indicated by the target value bar. + * Gets or sets the value indicated by the target value bar. */ targetValue?: number; /** - * Gets or sets the name used for the target value. The name is displayed in the default target value tooltip. + * Gets or sets the name used for the target value. The name is displayed in the default target value tooltip. */ targetValueName?: string; /** - * Gets or sets the value at which the bar ends. + * Gets or sets the value at which the bar ends. */ value?: number; /** - * Gets or sets the name used for actual value. + * Gets or sets the name used for actual value. */ valueName?: string; /** - * Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. + * Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ rangeInnerExtent?: number; /** - * Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ rangeOuterExtent?: number; /** - * Gets or sets the position at which to start rendering the actual value geometries, measured from the front/bottom of the bullet graph as a value from 0 to 1. + * Gets or sets the position at which to start rendering the actual value geometries, measured from the front/bottom of the bullet graph as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ valueInnerExtent?: number; /** - * Gets or sets the position at which to stop rendering the actual value geometries as a value from 0 to 1 measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to stop rendering the actual value geometries as a value from 0 to 1 measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ valueOuterExtent?: number; /** - * Gets or sets the interval to use for the scale. + * Gets or sets the interval to use for the scale. */ interval?: number; /** - * A value to start adding tickmarks, added to the scale's MinimumValue. + * A value to start adding tickmarks, added to the scale's MinimumValue. */ ticksPostInitial?: number; /** - * A value to stop adding tickmarks, subtracted from the scale's MaximumValue. + * A value to stop adding tickmarks, subtracted from the scale's MaximumValue. */ ticksPreTerminal?: number; /** - * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. + * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. */ labelInterval?: number; /** - * Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. + * Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. * Values further from zero than 1 can be used to hide the labels of the bullet graph. */ labelExtent?: number; /** - * A value to start adding labels, added to the scale's MinimumValue. + * A value to start adding labels, added to the scale's MinimumValue. */ labelsPostInitial?: number; /** - * A value to stop adding labels, subtracted from the scale's MaximumValue. + * A value to stop adding labels, subtracted from the scale's MaximumValue. */ labelsPreTerminal?: number; /** - * Gets or sets the number of minor tickmarks to place between major tickmarks. + * Gets or sets the number of minor tickmarks to place between major tickmarks. */ minorTickCount?: number; /** - * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ tickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ tickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering ticks. + * Gets or sets the stroke thickness to use when rendering ticks. */ tickStrokeThickness?: number; /** - * Gets or sets the brush to use for the major tickmarks. + * Gets or sets the brush to use for the major tickmarks. */ tickBrush?: string; /** - * Gets or sets the brush to use for the label font. + * Gets or sets the brush to use for the label font. */ fontBrush?: string; /** - * Gets or sets the brush to use for the actual value element. + * Gets or sets the brush to use for the actual value element. */ valueBrush?: string; /** - * Gets or sets the brush to use for the outline of actual value element. + * Gets or sets the brush to use for the outline of actual value element. */ valueOutline?: string; /** - * Gets or sets the stroke thickness to use when rendering single actual value element. + * Gets or sets the stroke thickness to use when rendering single actual value element. */ valueStrokeThickness?: number; /** - * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ minorTickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ minorTickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering minor ticks. + * Gets or sets the stroke thickness to use when rendering minor ticks. */ minorTickStrokeThickness?: number; /** - * Gets or sets the brush to use for the minor tickmarks. + * Gets or sets the brush to use for the minor tickmarks. */ minorTickBrush?: string; /** - * Gets or sets a value indicating whether the scale is inverted. + * Gets or sets a value indicating whether the scale is inverted. * When the scale is inverted the direction in which the scale values increase is right to left. */ isScaleInverted?: boolean; /** - * Gets or sets the brush to use to fill the backing of the bullet graph. + * Gets or sets the brush to use to fill the backing of the bullet graph. */ backingBrush?: string; /** - * Gets or sets the brush to use for the outline of the backing. + * Gets or sets the brush to use for the outline of the backing. */ backingOutline?: string; /** - * Gets or sets the stroke thickness of the backing outline. + * Gets or sets the stroke thickness of the backing outline. */ backingStrokeThickness?: number; /** - * Gets or sets the inner extent of the bullet graph backing. + * Gets or sets the inner extent of the bullet graph backing. */ backingInnerExtent?: number; /** - * Gets or sets the outer extent of the bullet graph backing. + * Gets or sets the outer extent of the bullet graph backing. */ backingOuterExtent?: number; /** - * Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the bullet graph as a value from 0 to 1. + * Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the bullet graph as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ scaleStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the bullet graph. + * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the bullet graph. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ scaleEndExtent?: number; /** - * Gets or sets the brush to use when rendering the fill of the comparative marker. + * Gets or sets the brush to use when rendering the fill of the comparative marker. */ targetValueBrush?: string; /** - * Get or sets the breadth of the target value element. + * Get or sets the breadth of the target value element. */ targetValueBreadth?: number; /** - * Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. + * Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ targetValueInnerExtent?: number; /** - * Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. + * Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. */ targetValueOuterExtent?: number; /** - * Gets or sets the brush to use when rendering the outline of the target value. + * Gets or sets the brush to use when rendering the outline of the target value. */ targetValueOutline?: string; /** - * Gets or sets the stroke thickness of the outline of the target value bar. + * Gets or sets the stroke thickness of the outline of the target value bar. */ targetValueStrokeThickness?: number; /** - * Gets or sets the number of milliseconds over which changes to the bullet graph should be animated. + * Gets or sets the number of milliseconds over which changes to the bullet graph should be animated. */ transitionDuration?: number; /** - * Gets or sets the time in milliseconds that tooltip appearance is delayed with. + * Gets or sets the time in milliseconds that tooltip appearance is delayed with. */ showToolTipTimeout?: number; /** - * Gets or sets a value indicating whether tooltips are enabled. + * Gets or sets a value indicating whether tooltips are enabled. */ showToolTip?: boolean; /** - * Gets or sets the font. + * Gets or sets the font. */ font?: string; pixelScalingRatio?: number; @@ -9918,54 +9918,54 @@ interface IgBulletGraph { alignLabel?: AlignLabelEvent; /** - * Option for igBulletGraph + * Option for igBulletGraph */ [optionName: string]: any; } interface IgBulletGraphMethods { /** - * Returns a string containing the names of all the ranges delimited with a \n symbol. + * Returns a string containing the names of all the ranges delimited with a \n symbol. */ getRangeNames(): void; /** - * Adds a new range to the bullet graph. + * Adds a new range to the bullet graph. * * @param value The range object to be added. */ addRange(value: Object): void; /** - * Removes a range from the bullet graph. + * Removes a range from the bullet graph. * * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true */ removeRange(value: Object): void; /** - * Updates the specified range of the bullet graph. + * Updates the specified range of the bullet graph. * * @param value The range object to be updated. */ updateRange(value: Object): void; /** - * Returns information about how the bullet graph is rendered. + * Returns information about how the bullet graph is rendered. */ exportVisualData(): Object; /** - * Causes all pending changes of the bullet graph e.g. by changed property values to be rendered immediately. + * Causes all pending changes of the bullet graph e.g. by changed property values to be rendered immediately. */ flush(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; /** - * Re-polls the css styles for the widget. Use this method when the css styles have been modified. + * Re-polls the css styles for the widget. Use this method when the css styles have been modified. */ styleUpdated(): void; } @@ -10737,291 +10737,291 @@ interface PropertyChangedEventUIParam { interface IgCategoryChart { /** - * Gets or sets the data value corresponding to the minimum value of the Y-axis. + * Gets or sets the data value corresponding to the minimum value of the Y-axis. */ yAxisMinimumValue?: number; /** - * Gets or sets the data value corresponding to the maximum value of the Y-axis. + * Gets or sets the data value corresponding to the maximum value of the Y-axis. */ yAxisMaximumValue?: number; /** - * Gets or sets the left margin of chart title + * Gets or sets the left margin of chart title */ titleLeftMargin?: number; /** - * Gets or sets the right margin of chart title + * Gets or sets the right margin of chart title */ titleRightMargin?: number; /** - * Gets or sets the top margin of chart title + * Gets or sets the top margin of chart title */ titleTopMargin?: number; /** - * Gets or sets the bottom margin of chart title + * Gets or sets the bottom margin of chart title */ titleBottomMargin?: number; /** - * Gets or sets the duration used for animating series plots when the chart is loading into view + * Gets or sets the duration used for animating series plots when the chart is loading into view */ transitionInDuration?: number; /** - * Gets or sets the duration used for animating series plots when the data is changing + * Gets or sets the duration used for animating series plots when the data is changing */ transitionDuration?: number; /** - * Gets or sets the easing function used for animating series plots when the chart is loading into view + * Gets or sets the easing function used for animating series plots when the chart is loading into view * This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number. */ transitionInEasingFunction?: any; /** - * Gets or sets the easing function used for animating series plots when the data is changing. + * Gets or sets the easing function used for animating series plots when the data is changing. * This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number. */ transitionEasingFunction?: any; /** - * Gets or sets the left margin of labels on the X-axis + * Gets or sets the left margin of labels on the X-axis */ xAxisLabelLeftMargin?: number; /** - * Gets or sets the top margin of labels on the X-axis + * Gets or sets the top margin of labels on the X-axis */ xAxisLabelTopMargin?: number; /** - * Gets or sets the right margin of labels on the X-axis + * Gets or sets the right margin of labels on the X-axis */ xAxisLabelRightMargin?: number; /** - * Gets or sets the bottom margin of labels on the X-axis + * Gets or sets the bottom margin of labels on the X-axis */ xAxisLabelBottomMargin?: number; /** - * Gets or sets the left margin of labels on the Y-axis + * Gets or sets the left margin of labels on the Y-axis */ yAxisLabelLeftMargin?: number; /** - * Gets or sets the top margin of labels on the Y-axis + * Gets or sets the top margin of labels on the Y-axis */ yAxisLabelTopMargin?: number; /** - * Gets or sets the right margin of labels on the Y-axis + * Gets or sets the right margin of labels on the Y-axis */ yAxisLabelRightMargin?: number; /** - * Gets or sets the bottom margin of labels on the Y-axis + * Gets or sets the bottom margin of labels on the Y-axis */ yAxisLabelBottomMargin?: number; /** - * Gets or sets color of labels on the X-axis + * Gets or sets color of labels on the X-axis */ xAxisLabelTextColor?: string; /** - * Gets or sets color of labels on the Y-axis + * Gets or sets color of labels on the Y-axis */ yAxisLabelTextColor?: string; /** - * Gets or sets CSS font property for labels on X-axis + * Gets or sets CSS font property for labels on X-axis */ xAxisLabelTextStyle?: string; /** - * Gets or sets CSS font property for labels on Y-axis + * Gets or sets CSS font property for labels on Y-axis */ yAxisLabelTextStyle?: string; /** - * Gets or sets the left margin of chart subtitle + * Gets or sets the left margin of chart subtitle */ subtitleLeftMargin?: number; /** - * Gets or sets the top margin of chart subtitle + * Gets or sets the top margin of chart subtitle */ subtitleTopMargin?: number; /** - * Gets or sets the right margin of chart subtitle + * Gets or sets the right margin of chart subtitle */ subtitleRightMargin?: number; /** - * Gets or sets the bottom margin of chart subtitle + * Gets or sets the bottom margin of chart subtitle */ subtitleBottomMargin?: number; /** - * Gets or sets color of chart subtitle + * Gets or sets color of chart subtitle */ subtitleTextColor?: string; /** - * Gets or sets CSS font property for the chart subtitle + * Gets or sets CSS font property for the chart subtitle */ subtitleTextStyle?: string; /** - * Gets or sets color of chart title + * Gets or sets color of chart title */ titleTextColor?: string; /** - * Gets or sets CSS font property for the chart title + * Gets or sets CSS font property for the chart title */ titleTextStyle?: string; /** - * Gets or sets the left margin of the chart content in the canvas + * Gets or sets the left margin of the chart content in the canvas */ leftMargin?: number; /** - * Gets or sets the top margin of the chart content in the canvas + * Gets or sets the top margin of the chart content in the canvas */ topMargin?: number; /** - * Gets or sets the right margin of the chart content in the canvas + * Gets or sets the right margin of the chart content in the canvas */ rightMargin?: number; /** - * Gets or sets the bottom margin around the chart content in the canvas + * Gets or sets the bottom margin around the chart content in the canvas */ bottomMargin?: number; /** - * Gets or sets the extent area dedicated to the a title on the X-axis. If unspecified, this value is auto-calculated. + * Gets or sets the extent area dedicated to the a title on the X-axis. If unspecified, this value is auto-calculated. */ xAxisTitleExtent?: number; /** - * Gets or sets the extent area dedicated to the a title on the Y-axis. If unspecified, this value is auto-calculated. + * Gets or sets the extent area dedicated to the a title on the Y-axis. If unspecified, this value is auto-calculated. */ yAxisTitleExtent?: number; /** - * Gets or sets the margin around a title on the X-axis + * Gets or sets the margin around a title on the X-axis */ xAxisTitleMargin?: number; /** - * Gets or sets the margin around a title on the Y-axis + * Gets or sets the margin around a title on the Y-axis */ yAxisTitleMargin?: number; /** - * Gets or sets the left margin of a title on the X-axis + * Gets or sets the left margin of a title on the X-axis */ xAxisTitleLeftMargin?: number; /** - * Gets or sets the left margin of a title on the Y-axis + * Gets or sets the left margin of a title on the Y-axis */ yAxisTitleLeftMargin?: number; /** - * Gets or sets the top margin of a title on the X-axis + * Gets or sets the top margin of a title on the X-axis */ xAxisTitleTopMargin?: number; /** - * Gets or sets the top margin of a title on the Y-axis + * Gets or sets the top margin of a title on the Y-axis */ yAxisTitleTopMargin?: number; /** - * Gets or sets the right margin of a title on the X-axis + * Gets or sets the right margin of a title on the X-axis */ xAxisTitleRightMargin?: number; /** - * Gets or sets the right margin of a title on the Y-axis + * Gets or sets the right margin of a title on the Y-axis */ yAxisTitleRightMargin?: number; /** - * Gets or sets the bottom margin of a title on the X-axis + * Gets or sets the bottom margin of a title on the X-axis */ xAxisTitleBottomMargin?: number; /** - * Gets or sets the bottom margin of a title on the Y-axis + * Gets or sets the bottom margin of a title on the Y-axis */ yAxisTitleBottomMargin?: number; /** - * Gets or sets the id of a template element to use for tooltips, or markup representing the tooltip template. + * Gets or sets the id of a template element to use for tooltips, or markup representing the tooltip template. */ tooltipTemplate?: string; /** - * Gets or sets function which takes an context object and returns a formatted label for the X-axis. + * Gets or sets function which takes an context object and returns a formatted label for the X-axis. */ xAxisFormatLabel?: any; /** - * Gets or sets function which takes a context object and returns a formatted label for the Y-axis. + * Gets or sets function which takes a context object and returns a formatted label for the Y-axis. */ yAxisFormatLabel?: any; /** - * Gets or sets color of title on the X-axis + * Gets or sets color of title on the X-axis */ xAxisTitleTextColor?: string; /** - * Gets or sets color of title on the Y-axis + * Gets or sets color of title on the Y-axis */ yAxisTitleTextColor?: string; /** - * Gets or sets CSS font property for title on X-axis + * Gets or sets CSS font property for title on X-axis */ xAxisTitleTextStyle?: string; /** - * Gets or sets CSS font property for title on Y-axis + * Gets or sets CSS font property for title on Y-axis */ yAxisTitleTextStyle?: string; widget?: any; /** - * Gets or sets a collection of data items used to generate the chart. + * Gets or sets a collection of data items used to generate the chart. * Value of this property can be a list of objects containing one or more numeric properties. Additionally, if the objects in the list implement the IEnumerable interface, the Category Chart will attempt to delve into the sub-collections when reading through the data source. Databinding can be further configured by attributing the data item classes with the DataSeriesMemberIntentAttribute. */ itemsSource?: any; /** - * Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remaineder excluded. If null, all properties will be considered. + * Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remaineder excluded. If null, all properties will be considered. */ includedProperties?: any; /** - * Gets or sets a set of property paths that should be excluded from consideration by the category chart. + * Gets or sets a set of property paths that should be excluded from consideration by the category chart. */ excludedProperties?: any; /** - * Gets or sets the type of chart series to generate from the data. + * Gets or sets the type of chart series to generate from the data. * * Valid values: * "line" Specifies category line series with markers at each data point @@ -11038,52 +11038,52 @@ interface IgCategoryChart { chartType?: string; /** - * Gets or sets the palette of brushes to use for coloring the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection + * Gets or sets the palette of brushes to use for coloring the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the palette of brushes to use for outlines on the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection + * Gets or sets the palette of brushes to use for outlines on the chart series. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; /** - * Sets the legend to connect this chart to. + * Sets the legend to connect this chart to. * When the legend property is set, the chart will use it to display information about its series. Legends can be shared by multiple chart controls. */ legend?: any; /** - * Gets or sets whether the chart should perform horizontal zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets or sets whether the chart should perform horizontal zoom when the user initiates a mouse wheel or mouse drag operation. */ isHorizontalZoomEnabled?: boolean; /** - * Gets or sets whether the chart should perform vertical zoom when the user initiates a mouse wheel or mouse drag operation. + * Gets or sets whether the chart should perform vertical zoom when the user initiates a mouse wheel or mouse drag operation. */ isVerticalZoomEnabled?: boolean; /** - * Gets or sets the rectangle representing the current scroll and zoom state of the chart. + * Gets or sets the rectangle representing the current scroll and zoom state of the chart. * WindowRect is expressed as a Rectangle with coordinates and sizes between 0 and 1. * The provided object should have numeric properties called left, top, width and height. */ windowRect?: any; /** - * Gets or sets text to display above the plot area. + * Gets or sets text to display above the plot area. */ title?: string; /** - * Gets or sets text to display below the chart Title, above the plot area. + * Gets or sets text to display below the chart Title, above the plot area. */ subtitle?: string; /** - * Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the chart. + * Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the chart. * * Valid values: * "left" @@ -11094,7 +11094,7 @@ interface IgCategoryChart { titleAlignment?: string; /** - * Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the chart. + * Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the chart. * * Valid values: * "left" @@ -11105,7 +11105,7 @@ interface IgCategoryChart { subtitleAlignment?: string; /** - * Gets or sets behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. + * Gets or sets behavior that determines how unknown values will be plotted on the chart.Null and Double.NaN are two examples of unknown values. * * * Valid values: @@ -11115,7 +11115,7 @@ interface IgCategoryChart { unknownValuePlotting?: string; /** - * Gets or sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. + * Gets or sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. * * Valid values: * "none" @@ -11124,12 +11124,12 @@ interface IgCategoryChart { markerCollisionAvoidance?: string; /** - * Gets or sets whether animation of series plots is enabled when the chart is loading into view + * Gets or sets whether animation of series plots is enabled when the chart is loading into view */ isTransitionInEnabled?: boolean; /** - * Gets or sets the method that determines how to animate series plots when the chart is loading into view + * Gets or sets the method that determines how to animate series plots when the chart is loading into view * * Valid values: * "auto" @@ -11156,7 +11156,7 @@ interface IgCategoryChart { transitionInMode?: string; /** - * Gets or sets the arrival speed used for animating series plots when the chart is loading into view + * Gets or sets the arrival speed used for animating series plots when the chart is loading into view * * Valid values: * "auto" @@ -11168,215 +11168,215 @@ interface IgCategoryChart { transitionInSpeedType?: string; /** - * Gets or sets the frequency of displayed labels along the X-axis. + * Gets or sets the frequency of displayed labels along the X-axis. * Gets or sets the set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label. */ xAxisInterval?: number; /** - * Gets or sets the frequency of displayed minor lines along the X-axis. + * Gets or sets the frequency of displayed minor lines along the X-axis. * Gets or sets the set value is a factor that determines how the minor lines will be displayed. */ xAxisMinorInterval?: number; /** - * Gets or sets the amount of space between adjacent categories for the X-axis. + * Gets or sets the amount of space between adjacent categories for the X-axis. * The gap is silently clamped to the range [0, 1] when used. */ xAxisGap?: number; /** - * Gets or sets the amount of overlap between adjacent categories for the X-axis. + * Gets or sets the amount of overlap between adjacent categories for the X-axis. * Gets or sets the overlap is silently clamped to the range [-1, 1] when used. */ xAxisOverlap?: number; /** - * Gets or sets the distance between each labels and grid line along the Y-axis. + * Gets or sets the distance between each labels and grid line along the Y-axis. */ yAxisInterval?: number; /** - * Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. + * Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. * Since log(-1) is imaginary and log(0) is undefined, it is recommended to enable this property only when the Y-axis minimum is greater than zero. */ yAxisIsLogarithmic?: boolean; /** - * Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. + * Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. * This property is effective only when YAxisIsLogarithmic is true. */ yAxisLogarithmBase?: number; /** - * Gets or sets the frequency of displayed minor lines along the Y-axis. + * Gets or sets the frequency of displayed minor lines along the Y-axis. */ yAxisMinorInterval?: number; /** - * Gets or sets the format for labels along the X-axis. + * Gets or sets the format for labels along the X-axis. */ xAxisLabel?: any; /** - * Gets or sets the format for labels along the Y-axis. + * Gets or sets the format for labels along the Y-axis. */ yAxisLabel?: any; /** - * Gets or sets the color to apply to major gridlines along the X-axis. + * Gets or sets the color to apply to major gridlines along the X-axis. */ xAxisMajorStroke?: string; /** - * Gets or sets the color to apply to major gridlines along the Y-axis. + * Gets or sets the color to apply to major gridlines along the Y-axis. */ yAxisMajorStroke?: string; /** - * Gets or sets the thickness to apply to major gridlines along the X-axis. + * Gets or sets the thickness to apply to major gridlines along the X-axis. */ xAxisMajorStrokeThickness?: number; /** - * Gets or sets the thickness to apply to major gridlines along the Y-axis. + * Gets or sets the thickness to apply to major gridlines along the Y-axis. */ yAxisMajorStrokeThickness?: number; /** - * Gets or sets the thickness to apply to minor gridlines along the X-axis. + * Gets or sets the thickness to apply to minor gridlines along the X-axis. */ xAxisMinorStrokeThickness?: number; /** - * Gets or sets the thickness to apply to minor gridlines along the Y-axis. + * Gets or sets the thickness to apply to minor gridlines along the Y-axis. */ yAxisMinorStrokeThickness?: number; /** - * Gets or sets the color to apply to stripes along the X-axis. + * Gets or sets the color to apply to stripes along the X-axis. */ xAxisStrip?: string; /** - * Gets or sets the color to apply to stripes along the Y-axis. + * Gets or sets the color to apply to stripes along the Y-axis. */ yAxisStrip?: string; /** - * Gets or sets the color to apply to the X-axis line. + * Gets or sets the color to apply to the X-axis line. */ xAxisStroke?: string; /** - * Gets or sets the color to apply to the Y-axis line. + * Gets or sets the color to apply to the Y-axis line. */ yAxisStroke?: string; /** - * Gets or sets the thickness to apply to the X-axis line. + * Gets or sets the thickness to apply to the X-axis line. */ xAxisStrokeThickness?: number; /** - * Gets or sets the thickness to apply to the Y-axis line. + * Gets or sets the thickness to apply to the Y-axis line. */ yAxisStrokeThickness?: number; /** - * Gets or sets the length of tickmarks along the X-axis. + * Gets or sets the length of tickmarks along the X-axis. */ xAxisTickLength?: number; /** - * Gets or sets the length of tickmarks along the Y-axis. + * Gets or sets the length of tickmarks along the Y-axis. */ yAxisTickLength?: number; /** - * Gets or sets the color to apply to tickmarks along the X-axis. + * Gets or sets the color to apply to tickmarks along the X-axis. */ xAxisTickStroke?: string; /** - * Gets or sets the color to apply to tickmarks along the Y-axis. + * Gets or sets the color to apply to tickmarks along the Y-axis. */ yAxisTickStroke?: string; /** - * Gets or sets the thickness to apply to tickmarks along the X-axis. + * Gets or sets the thickness to apply to tickmarks along the X-axis. */ xAxisTickStrokeThickness?: number; /** - * Gets or sets the thickness to apply to tickmarks along the Y-axis. + * Gets or sets the thickness to apply to tickmarks along the Y-axis. */ yAxisTickStrokeThickness?: number; /** - * Text to display below the X-axis. + * Text to display below the X-axis. */ xAxisTitle?: string; /** - * Text to display to the left of the Y-axis. + * Text to display to the left of the Y-axis. */ yAxisTitle?: string; /** - * Gets or sets the color to apply to minor gridlines along the X-axis. + * Gets or sets the color to apply to minor gridlines along the X-axis. */ xAxisMinorStroke?: string; /** - * Gets or sets the color to apply to minor gridlines along the Y-axis. + * Gets or sets the color to apply to minor gridlines along the Y-axis. */ yAxisMinorStroke?: string; /** - * Gets or sets the angle of rotation for labels along the X-axis. + * Gets or sets the angle of rotation for labels along the X-axis. */ xAxisLabelAngle?: number; /** - * Gets or sets the angle of rotation for labels along the Y-axis. + * Gets or sets the angle of rotation for labels along the Y-axis. */ yAxisLabelAngle?: number; /** - * Gets or sets the distance between the X-axis and the bottom of the chart. + * Gets or sets the distance between the X-axis and the bottom of the chart. */ xAxisExtent?: number; /** - * Gets or sets the distance between the Y-axis and the left edge of the chart. + * Gets or sets the distance between the Y-axis and the left edge of the chart. */ yAxisExtent?: number; /** - * Gets or sets the angle of rotation for the X-axis title. + * Gets or sets the angle of rotation for the X-axis title. */ xAxisTitleAngle?: number; /** - * Gets or sets the angle of rotation for the Y-axis title. + * Gets or sets the angle of rotation for the Y-axis title. */ yAxisTitleAngle?: number; /** - * Gets or sets the rendering resolution for series in this chart. + * Gets or sets the rendering resolution for series in this chart. * Where n = Resolution, for every n horizontal pixels, combine all items into a single datapoint. When Resolution = 0, all datapoints will be rendered as graphical objects. Charts with a higher resolution will have faster performance. */ resolution?: number; /** - * Gets or sets the palette of brushes to used for coloring trend lines in this chart. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection + * Gets or sets the palette of brushes to used for coloring trend lines in this chart. The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ trendLineBrushes?: any; /** - * Gets or sets the formula used for calculating trend lines in this chart. + * Gets or sets the formula used for calculating trend lines in this chart. * * Valid values: * "none" @@ -11397,51 +11397,51 @@ interface IgCategoryChart { trendLineType?: string; /** - * Gets or sets the thickness of the chart series. Depending on the ChartType, this can be the main brush used, or just the outline. + * Gets or sets the thickness of the chart series. Depending on the ChartType, this can be the main brush used, or just the outline. */ thickness?: number; /** - * Gets or sets collection of marker shapes used for representing data points of series in this chart. + * Gets or sets collection of marker shapes used for representing data points of series in this chart. * When MarkerTypes is null or empty, each series' marker type will be set to none or automatic, depending on the series type. */ markerTypes?: any; /** - * Gets or sets the palette of brushes used for coloring fill of data point markers. + * Gets or sets the palette of brushes used for coloring fill of data point markers. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ markerBrushes?: any; /** - * Gets or sets the palette of brushes used for coloring outline of data point markers. + * Gets or sets the palette of brushes used for coloring outline of data point markers. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ markerOutlines?: any; /** - * Gets or sets the thickness of the trend lines in this chart. + * Gets or sets the thickness of the trend lines in this chart. */ trendLineThickness?: number; /** - * Gets or sets whether the direction of the X-axis is inverted, placing the first data items on the right side instead of left side + * Gets or sets whether the direction of the X-axis is inverted, placing the first data items on the right side instead of left side */ xAxisInverted?: boolean; /** - * Gets or sets whether the direction of the Y-axis is inverted, placing minimum numeric value at the top of the axis instead of bottom + * Gets or sets whether the direction of the Y-axis is inverted, placing minimum numeric value at the top of the axis instead of bottom */ yAxisInverted?: boolean; /** - * Gets or sets the palette used for coloring negative items of Waterfall chart type. + * Gets or sets the palette used for coloring negative items of Waterfall chart type. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ negativeBrushes?: any; /** - * Gets or sets the horizontal alignment of the X-axis title. + * Gets or sets the horizontal alignment of the X-axis title. * * Valid values: * "left" @@ -11452,7 +11452,7 @@ interface IgCategoryChart { xAxisTitleAlignment?: string; /** - * Gets or sets the vertical alignment of the Y-axis title. + * Gets or sets the vertical alignment of the Y-axis title. * * Valid values: * "top" @@ -11463,7 +11463,7 @@ interface IgCategoryChart { yAxisTitleAlignment?: string; /** - * Gets or sets the horizontal alignment of X-axis labels. + * Gets or sets the horizontal alignment of X-axis labels. * * Valid values: * "left" @@ -11474,7 +11474,7 @@ interface IgCategoryChart { xAxisLabelHorizontalAlignment?: string; /** - * Gets or sets the horizontal alignment of Y-axis labels. + * Gets or sets the horizontal alignment of Y-axis labels. * * Valid values: * "left" @@ -11485,7 +11485,7 @@ interface IgCategoryChart { yAxisLabelHorizontalAlignment?: string; /** - * Gets or sets the vertical alignment of X-axis labels. + * Gets or sets the vertical alignment of X-axis labels. * * Valid values: * "top" @@ -11496,7 +11496,7 @@ interface IgCategoryChart { xAxisLabelVerticalAlignment?: string; /** - * Gets or sets the vertical alignment of Y-axis labels. + * Gets or sets the vertical alignment of Y-axis labels. * * Valid values: * "top" @@ -11507,7 +11507,7 @@ interface IgCategoryChart { yAxisLabelVerticalAlignment?: string; /** - * Gets or sets the visibility of X-axis labels. + * Gets or sets the visibility of X-axis labels. * * Valid values: * "visible" @@ -11516,7 +11516,7 @@ interface IgCategoryChart { xAxisLabelVisibility?: string; /** - * Gets or sets the visibility of Y-axis labels. + * Gets or sets the visibility of Y-axis labels. * * Valid values: * "visible" @@ -11526,59 +11526,59 @@ interface IgCategoryChart { negativeOutlines?: any; /** - * Gets or sets a value indicating whether grid and tick lines are aligned to device pixels. + * Gets or sets a value indicating whether grid and tick lines are aligned to device pixels. */ alignsGridLinesToPixels?: boolean; /** - * The width of the chart. + * The width of the chart. */ width?: number; /** - * The height of the chart. + * The height of the chart. */ height?: number; /** - * Gets sets maximum number of displayed records in chart. + * Gets sets maximum number of displayed records in chart. */ maxRecCount?: number; /** - * Gets sets a valid data source. + * Gets sets a valid data source. * That can be instance of array or primitives, array of objects, instance of $.ig.DataSource, or any other data accepted by $.ig.DataSource. * Note: if it is set to string and "dataSourceType" option is not set, then $.ig.JSONPDataSource is used. */ dataSource?: any; /** - * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property + * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property */ dataSourceType?: string; /** - * Gets sets url which is used for sending JSON on request for remote data. + * Gets sets url which is used for sending JSON on request for remote data. */ dataSourceUrl?: string; /** - * See $.ig.DataSource. property in the response specifying the total number of records on the server. + * See $.ig.DataSource. property in the response specifying the total number of records on the server. */ responseTotalRecCountKey?: string; /** - * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. + * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. */ responseDataKey?: string; /** - * Event raised when a property value is changed. + * Event raised when a property value is changed. */ propertyChanged?: PropertyChangedEvent; /** - * Event which is raised before data binding. + * Event which is raised before data binding. * Return false in order to cancel data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -11587,7 +11587,7 @@ interface IgCategoryChart { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding. + * Event which is raised after data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. * Use ui.data to obtain reference to array actual data which is displayed by chart. @@ -11596,7 +11596,7 @@ interface IgCategoryChart { dataBound?: DataBoundEvent; /** - * Event which is raised before tooltip is updated. + * Event which is raised before tooltip is updated. * Return false in order to cancel updating and hide tooltip. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -11609,7 +11609,7 @@ interface IgCategoryChart { updateTooltip?: UpdateTooltipEvent; /** - * Event which is raised before tooltip is hidden. + * Event which is raised before tooltip is hidden. * Return false in order to cancel hiding and keep tooltip visible. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -11619,7 +11619,7 @@ interface IgCategoryChart { hideTooltip?: HideTooltipEvent; /** - * Option for igCategoryChart + * Option for igCategoryChart */ [optionName: string]: any; } @@ -11629,33 +11629,33 @@ interface IgCategoryChartMethods { exportVisualData(): void; /** - * Find index of item within actual data used by chart. + * Find index of item within actual data used by chart. * * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** - * Get item within actual data used by chart. That is similar to this.getData()[ index ]. + * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * * @param index Index of data item. */ getDataItem(index: Object): Object; /** - * Get reference of actual data used by chart. + * Get reference of actual data used by chart. */ getData(): any[]; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -11663,14 +11663,14 @@ interface IgCategoryChartMethods { insertItem(item: Object, index: number): Object; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -11678,7 +11678,7 @@ interface IgCategoryChartMethods { setItem(index: number, item: Object): Object; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -11688,16 +11688,16 @@ interface IgCategoryChartMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -11706,8 +11706,8 @@ interface IgCategoryChartMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -11716,12 +11716,12 @@ interface IgCategoryChartMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Get reference to chart object. + * Get reference to chart object. */ chart(): Object; /** - * Binds data to the chart + * Binds data to the chart */ dataBind(): void; } @@ -13574,29 +13574,29 @@ interface JQuery { } interface IgDataChartCrosshairPoint { /** - * The x coordinate. + * The x coordinate. */ x?: number; /** - * The y coordinate. + * The y coordinate. */ y?: number; /** - * Option for IgDataChartCrosshairPoint + * Option for IgDataChartCrosshairPoint */ [optionName: string]: any; } interface IgDataChartLegend { /** - * The name of the element to turn into a legend. + * The name of the element to turn into a legend. */ element?: string; /** - * Type of the legend. + * Type of the legend. * * Valid values: * "item" Specify the legend as item legend. It displays a legend item for each pie in the igPieChart control. @@ -13605,7 +13605,7 @@ interface IgDataChartLegend { type?: string; /** - * The width of the legend. + * The width of the legend. * * Valid values: * "null" will stretch to fit data, if no other widths are defined. @@ -13613,7 +13613,7 @@ interface IgDataChartLegend { width?: string|number; /** - * The height of the legend.null will stretch vertically to fit data, no other height are defined. + * The height of the legend.null will stretch vertically to fit data, no other height are defined. * * * Valid values: @@ -13622,14 +13622,14 @@ interface IgDataChartLegend { height?: string|number; /** - * Option for IgDataChartLegend + * Option for IgDataChartLegend */ [optionName: string]: any; } interface IgDataChartAxes { /** - * Type of the axis. + * Type of the axis. * * Valid values: * "numericX" Specify the axis as numeric X axis. Useful for displaying scatter, category and financial price series. @@ -13644,37 +13644,37 @@ interface IgDataChartAxes { type?: string; /** - * The unique identifier of the axis. + * The unique identifier of the axis. */ name?: string; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Set to true in order to have an existing axis removed from the chart, by name + * Set to true in order to have an existing axis removed from the chart, by name */ remove?: boolean; /** - * Specifies the location to display the axis labels for this axis. + * Specifies the location to display the axis labels for this axis. * * Valid values: * "outsideTop" The labels should have an outside top position. @@ -13689,7 +13689,7 @@ interface IgDataChartAxes { labelLocation?: string; /** - * Specifies whether the labels are visible. + * Specifies whether the labels are visible. * * Valid values: * "visible" The labels should be visisble for this axis. @@ -13698,117 +13698,117 @@ interface IgDataChartAxes { labelVisibility?: string; /** - * Specifies the extent of the area dedicated to the labels for this axis. If unspecified, this value is auto-calculated. + * Specifies the extent of the area dedicated to the labels for this axis. If unspecified, this value is auto-calculated. */ labelExtent?: number; /** - * Specifies the angle that labels on the axis should be rotated + * Specifies the angle that labels on the axis should be rotated */ labelAngle?: number; /** - * Overrides the style of the text used for the axis labels. + * Overrides the style of the text used for the axis labels. */ labelTextStyle?: string; /** - * Overrides the color of the text used for the axis labels. + * Overrides the color of the text used for the axis labels. */ labelTextColor?: string; /** - * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. + * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. */ formatLabel?: any; /** - * Gets or sets the Stroke property. + * Gets or sets the Stroke property. */ stroke?: string; /** - * Gets or sets the StrokeThickness property. + * Gets or sets the StrokeThickness property. */ strokeThickness?: number; /** - * Gets or sets the Strip property. + * Gets or sets the Strip property. */ strip?: string; /** - * Gets or sets the MajorStroke property. + * Gets or sets the MajorStroke property. */ majorStroke?: string; /** - * Gets or sets the MajorStrokeThickness property. + * Gets or sets the MajorStrokeThickness property. */ majorStrokeThickness?: number; /** - * Gets or sets the MinorStroke property. + * Gets or sets the MinorStroke property. */ minorStroke?: string; /** - * Gets or sets the MinorStrokeThickness property. + * Gets or sets the MinorStrokeThickness property. */ minorStrokeThickness?: number; /** - * Gets or sets the IsInverted property. + * Gets or sets the IsInverted property. */ isInverted?: boolean; /** - * Gets or sets the CrossingAxis property. + * Gets or sets the CrossingAxis property. */ crossingAxis?: string; /** - * Gets or sets the CrossingValue property. + * Gets or sets the CrossingValue property. */ crossingValue?: any; /** - * Gets or sets the coercion methods to use when loading data from data sources. + * Gets or sets the coercion methods to use when loading data from data sources. * Should be specified before setting any member paths, if being used. Setting it later * will not cause data to be reimported into the chart. */ coercionMethods?: any; /** - * Gets or sets the axis label format string. + * Gets or sets the axis label format string. */ label?: any; /** - * Gets or sets the amount of space between adjacent categories for the current axis object. + * Gets or sets the amount of space between adjacent categories for the current axis object. * The gap is silently clamped to the range [0, 1] when used. */ gap?: number; /** - * Gets or sets the amount of overlap between adjacent categories for the current axis object. + * Gets or sets the amount of overlap between adjacent categories for the current axis object. * The overlap is silently clamped to the range [-1, 1] when used. */ overlap?: number; /** - * Indicates the angle in degress that the chart's 0th angle should be offset. + * Indicates the angle in degress that the chart's 0th angle should be offset. */ startAngleOffset?: number; /** - * Gets or sets the frequency of displayed labels. + * Gets or sets the frequency of displayed labels. * The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label. */ interval?: number; /** - * Gets or sets the axis display type. Continuous display type divides the axis into even intervals, where labels will not necessarily be aligned with data points. Discrete display type will not use a constant interval, but will align each label with its data point. + * Gets or sets the axis display type. Continuous display type divides the axis into even intervals, where labels will not necessarily be aligned with data points. Discrete display type will not use a constant interval, but will align each label with its data point. * * Valid values: * "continuous" Points occur at even intervals, even where data is not present at a given point. @@ -13817,12 +13817,12 @@ interface IgDataChartAxes { displayType?: string; /** - * Gets or sets whether the data assigned to the date time axis should be considered pre-sorted by date/time. + * Gets or sets whether the data assigned to the date time axis should be considered pre-sorted by date/time. */ isDataPreSorted?: boolean; /** - * Gets or sets the axis MinimumValue. + * Gets or sets the axis MinimumValue. * * * Valid values: @@ -13832,7 +13832,7 @@ interface IgDataChartAxes { minimumValue?: number|Date; /** - * Gets or sets the axis MaximumValue. + * Gets or sets the axis MaximumValue. * * * Valid values: @@ -13842,54 +13842,54 @@ interface IgDataChartAxes { maximumValue?: number|Date; /** - * Gets or sets the DateTime mapping property for the CategoryDateTimeXAxis. + * Gets or sets the DateTime mapping property for the CategoryDateTimeXAxis. */ dateTimeMemberPath?: string; /** - * Gets or sets the ReferenceValue property. + * Gets or sets the ReferenceValue property. */ referenceValue?: number; /** - * Gets or sets the IsLogarithmic property. + * Gets or sets the IsLogarithmic property. */ isLogarithmic?: boolean; /** - * Gets or sets the LogarithmBase property. + * Gets or sets the LogarithmBase property. */ logarithmBase?: number; /** - * Defines the percentage of the maximum radius extent to use as the maximum radius. Should be + * Defines the percentage of the maximum radius extent to use as the maximum radius. Should be * a value between 0.0 and 1.0. */ radiusExtentScale?: number; /** - * Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be + * Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be * a value between 0.0 and 1.0. */ innerRadiusExtentScale?: number; /** - * The title to display for the component. + * The title to display for the component. */ title?: string; /** - * The css font property to use for the title. + * The css font property to use for the title. */ titleTextStyle?: string; /** - * The margin to display around the title of the axis. + * The margin to display around the title of the axis. */ titleMargin?: number; /** - * the horizontal alignment to use for the title. + * the horizontal alignment to use for the title. * * Valid values: * "left" left aligns the title. @@ -13899,7 +13899,7 @@ interface IgDataChartAxes { titleHorizontalAlignment?: string; /** - * the vertical alignment to use for the title. + * the vertical alignment to use for the title. * * Valid values: * "center" center aligns the title. @@ -13907,7 +13907,7 @@ interface IgDataChartAxes { titleVerticalAlignment?: string; /** - * the position to use for the title. + * the position to use for the title. * * Valid values: * "auto" the title is positioned automatically. @@ -13919,27 +13919,27 @@ interface IgDataChartAxes { titlePosition?: string; /** - * The top margin to use for the title. + * The top margin to use for the title. */ titleTopMargin?: number; /** - * The left margin to use for the title. + * The left margin to use for the title. */ titleLeftMargin?: number; /** - * The right margin to use for the title. + * The right margin to use for the title. */ titleRightMargin?: number; /** - * The bottom margin to use for the title. + * The bottom margin to use for the title. */ titleBottomMargin?: number; /** - * the horizontal alignment to use for the labels. Only applicable to vertical axes. + * the horizontal alignment to use for the labels. Only applicable to vertical axes. * * Valid values: * "left" left aligns the labels. @@ -13949,7 +13949,7 @@ interface IgDataChartAxes { labelHorizontalAlignment?: string; /** - * the vertical alignment to use for the labels. Only applicable to horizontal axes. + * the vertical alignment to use for the labels. Only applicable to horizontal axes. * * Valid values: * "top" top aligns the labels. @@ -13959,84 +13959,84 @@ interface IgDataChartAxes { labelVerticalAlignment?: string; /** - * The margin to use for the labels. + * The margin to use for the labels. */ labelMargin?: number; /** - * The top margin to use for the labels. + * The top margin to use for the labels. */ labelTopMargin?: number; /** - * The left margin to use for the labels. + * The left margin to use for the labels. */ labelLeftMargin?: number; /** - * The right margin to use for the labels. + * The right margin to use for the labels. */ labelRightMargin?: number; /** - * The bottom margin to use for the labels. + * The bottom margin to use for the labels. */ labelBottomMargin?: number; /** - * Sets whether or not to show the first label on the axis. + * Sets whether or not to show the first label on the axis. */ showFirstLabel?: boolean; /** - * The angle to use for the axis title. + * The angle to use for the axis title. */ titleAngle?: number; /** - * The length of the tickmarks to display for this axis. + * The length of the tickmarks to display for this axis. */ tickLength?: number; /** - * The stroke thickness to use for the tickmarks. + * The stroke thickness to use for the tickmarks. */ tickStrokeThickness?: number; /** - * The color to use for the tickmarks. + * The color to use for the tickmarks. */ tickStroke?: any; /** - * Gets or sets whether the cateogory axis should use clustering display mode even if no series are present that would force clustering mode. + * Gets or sets whether the cateogory axis should use clustering display mode even if no series are present that would force clustering mode. */ useClusteringMode?: boolean; /** - * Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc. + * Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc. */ useEnhancedIntervalManagement?: boolean; /** - * Gets or sets the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels. + * Gets or sets the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels. */ enhancedIntervalMinimumCharacters?: number; /** - * Option for IgDataChartAxes + * Option for IgDataChartAxes */ [optionName: string]: any; } interface IgDataChartSeriesLegend { /** - * The name of the element to turn into a legend. + * The name of the element to turn into a legend. */ element?: string; /** - * Type of the legend. + * Type of the legend. * * Valid values: * "item" Specify the legend as item legend. It displays a legend item for each pie in the igPieChart control. @@ -14045,7 +14045,7 @@ interface IgDataChartSeriesLegend { type?: string; /** - * The width of the legend. + * The width of the legend. * * Valid values: * "null" will stretch to fit data, if no other widths are defined @@ -14053,7 +14053,7 @@ interface IgDataChartSeriesLegend { width?: string|number; /** - * The height of the legend.null will stretch vertically to fit data, no other height are defined + * The height of the legend.null will stretch vertically to fit data, no other height are defined * * * Valid values: @@ -14062,14 +14062,14 @@ interface IgDataChartSeriesLegend { height?: string|number; /** - * Option for IgDataChartSeriesLegend + * Option for IgDataChartSeriesLegend */ [optionName: string]: any; } interface IgDataChartSeries { /** - * Type of the series. + * Type of the series. * * Valid values: * "area" Specify the series as Area series. @@ -14102,52 +14102,52 @@ interface IgDataChartSeries { type?: string; /** - * The unique identifier of the series. + * The unique identifier of the series. */ name?: string; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Set to true in order to have an existing series removed from the chart, by name + * Set to true in order to have an existing series removed from the chart, by name */ remove?: boolean; /** - * Whether the chart should render a tooltip. + * Whether the chart should render a tooltip. */ showTooltip?: boolean; /** - * The name of template or the template itself that chart tooltip will use to render. + * The name of template or the template itself that chart tooltip will use to render. */ tooltipTemplate?: string; /** - * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. + * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. */ legend?: IgDataChartSeriesLegend; /** - * Gets or sets the legend item visibility for the current series object. + * Gets or sets the legend item visibility for the current series object. * * Valid values: * "visible" The legend item should be visible. @@ -14156,7 +14156,7 @@ interface IgDataChartSeries { legendItemVisibility?: string; /** - * Gets or sets the LegendItemBadgeTemplate property. + * Gets or sets the LegendItemBadgeTemplate property. * The legend item badge is created according to the LegendItemBadgeTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. @@ -14183,7 +14183,7 @@ interface IgDataChartSeries { legendItemBadgeTemplate?: any; /** - * Gets or sets the LegendItemTemplate property. + * Gets or sets the LegendItemTemplate property. * The legend item control content is created according to the LegendItemTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -14191,7 +14191,7 @@ interface IgDataChartSeries { legendItemTemplate?: any; /** - * Gets or sets the DiscreteLegendItemTemplate property. + * Gets or sets the DiscreteLegendItemTemplate property. * The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -14199,52 +14199,52 @@ interface IgDataChartSeries { discreteLegendItemTemplate?: any; /** - * Gets or sets the duration of the current series's morph. + * Gets or sets the duration of the current series's morph. */ transitionDuration?: number; /** - * Provides an easing function to use for the transitions. This should either be a well known name of an easing function (The only currently supported name is cubic), or it should be a function that takes a number and returns the output with the function applied. + * Provides an easing function to use for the transitions. This should either be a well known name of an easing function (The only currently supported name is cubic), or it should be a function that takes a number and returns the output with the function applied. */ transitionEasingFunction?: any; /** - * Gets or sets the current series object's rendering resolution. + * Gets or sets the current series object's rendering resolution. */ resolution?: number; /** - * Gets or sets the Title property. + * Gets or sets the Title property. * The legend item control is created according to the Title on-demand by * the series object itself. */ title?: string; /** - * Gets or sets the brush to use for the series. + * Gets or sets the brush to use for the series. */ brush?: string; /** - * Gets or sets the brush to use for the outline of the series. + * Gets or sets the brush to use for the outline of the series. * Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts. */ outline?: string; /** - * Gets or sets the width of the current series object's line thickness. + * Gets or sets the width of the current series object's line thickness. */ thickness?: number; /** - * Gets or gets the coercion methods to use when loading data from data sources. + * Gets or gets the coercion methods to use when loading data from data sources. * Should be specified before setting any member paths, if being used. Setting it later * will not cause data to be reimported into the chart. */ coercionMethods?: any; /** - * Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored. + * Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored. * * Valid values: * "unset" Marker hasn't been set. @@ -14264,43 +14264,43 @@ interface IgDataChartSeries { markerType?: string; /** - * Gets or sets the MarkerTemplate for the current series object. + * Gets or sets the MarkerTemplate for the current series object. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate */ markerTemplate?: any; /** - * Gets or sets the brush that specifies how the current series object's marker interiors are painted. + * Gets or sets the brush that specifies how the current series object's marker interiors are painted. */ markerBrush?: string; /** - * Gets or sets the brush that specifies how the current series object's marker outlines are painted. + * Gets or sets the brush that specifies how the current series object's marker outlines are painted. */ markerOutline?: string; /** - * Gets or sets the effective x-axis for the current object. + * Gets or sets the effective x-axis for the current object. */ xAxis?: string; /** - * Gets or sets the effective y-axis for the current object. + * Gets or sets the effective y-axis for the current object. */ yAxis?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ xMemberPath?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ yMemberPath?: string; /** - * Gets or sets the trend type for the current scatter series. + * Gets or sets the trend type for the current scatter series. * * Valid values: * "none" No trendline should display. @@ -14321,35 +14321,35 @@ interface IgDataChartSeries { trendLineType?: string; /** - * Gets or sets the brush to use to draw the trend line. + * Gets or sets the brush to use to draw the trend line. */ trendLineBrush?: string; /** - * Gets or sets the thickness of the current scatter series object's trend line. + * Gets or sets the thickness of the current scatter series object's trend line. */ trendLineThickness?: number; /** - * Gets or sets the moving average period for the current scatter series object. + * Gets or sets the moving average period for the current scatter series object. * The typical, and initial, value for trend line period is 7. */ trendLinePeriod?: number; /** - * Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data. + * Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data. */ trendLineZIndex?: number; /** - * Gets or sets the maximum number of markerItems displayed by the current series. + * Gets or sets the maximum number of markerItems displayed by the current series. * If more than the specified number of markerItems are visible, the series will automatically * choose a representative set. */ maximumMarkers?: number; /** - * Determines how unknown values will be plotted on the chart. Null and Double.NaN are two examples of unknown values. + * Determines how unknown values will be plotted on the chart. Null and Double.NaN are two examples of unknown values. * * Valid values: * "linearInterpolate" Plot the unknown value as the midpoint between surrounding known values using linear interpolation. @@ -14358,84 +14358,84 @@ interface IgDataChartSeries { unknownValuePlotting?: string; /** - * Gets or sets the radius mapping property for the current series object. + * Gets or sets the radius mapping property for the current series object. */ radiusMemberPath?: string; /** - * Gets or sets the radius size scale for the bubbles. + * Gets or sets the radius size scale for the bubbles. */ radiusScale?: any; /** - * Gets or sets the Label mapping property for the current series object. + * Gets or sets the Label mapping property for the current series object. */ labelMemberPath?: string; /** - * Gets or sets the fill mapping property for the current series object. + * Gets or sets the fill mapping property for the current series object. */ fillMemberPath?: string; /** - * Gets or sets the brush scale for the marker brush. + * Gets or sets the brush scale for the marker brush. */ fillScale?: any; /** - * Gets the effective angle axis for the current series object. + * Gets the effective angle axis for the current series object. */ angleAxis?: string; /** - * Gets the effective value axis for the current series object. + * Gets the effective value axis for the current series object. */ valueAxis?: string; /** - * Gets or sets whether to clip the series to the bounds. + * Gets or sets whether to clip the series to the bounds. * Setting this to true can effect performance. */ clipSeriesToBounds?: boolean; /** - * Gets or sets the item path that provides the values for the current series. + * Gets or sets the item path that provides the values for the current series. */ valueMemberPath?: string; /** - * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. + * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. */ radiusX?: number; /** - * Gets or sets the y-radius of the ellipse that is used to round the corners of the column. + * Gets or sets the y-radius of the ellipse that is used to round the corners of the column. */ radiusY?: number; /** - * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. + * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. */ angleMemberPath?: number; /** - * Gets the effective radius axis for the current series object. + * Gets the effective radius axis for the current series object. */ radiusAxis?: string; /** - * Gets or sets whether Cartesian Interpolation should be used rather than Archimedian + * Gets or sets whether Cartesian Interpolation should be used rather than Archimedian * spiral based interpolation. */ useCartesianInterpolation?: boolean; /** - * Gets or sets the brush to use for negative portions of the series. + * Gets or sets the brush to use for negative portions of the series. */ negativeBrush?: string; /** - * Gets or sets the type of spline to be rendered. + * Gets or sets the type of spline to be rendered. * * Valid values: * "natural" Calculates the spline using a natural spline calculation formula. @@ -14444,32 +14444,32 @@ interface IgDataChartSeries { splineType?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ lowMemberPath?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ highMemberPath?: string; /** - * Gets or sets the open mapping property for the current series object. + * Gets or sets the open mapping property for the current series object. */ openMemberPath?: string; /** - * Gets or sets the close mapping property for the current series object. + * Gets or sets the close mapping property for the current series object. */ closeMemberPath?: string; /** - * Gets or sets the volume mapping property for the current series object. + * Gets or sets the volume mapping property for the current series object. */ volumeMemberPath?: string; /** - * Gets or sets the display for the current FinancialIndicator object. + * Gets or sets the display for the current FinancialIndicator object. * * Valid values: * "candlestick" Displays prices as a Japanese Candlestick. @@ -14478,30 +14478,30 @@ interface IgDataChartSeries { displayType?: string; /** - * Gets or sets the number of values to hide at the beginning of the indicator. + * Gets or sets the number of values to hide at the beginning of the indicator. */ ignoreFirst?: number; /** - * Gets or sets the moving average period for the current AverageDirectionalIndexIndicator object. + * Gets or sets the moving average period for the current AverageDirectionalIndexIndicator object. * The typical, and initial, value for AverageDirectionalIndexIndicator periods is 14. */ period?: number; /** - * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. + * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. * The typical, and initial, value for short AVO periods is 10. */ shortPeriod?: number; /** - * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. + * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. * The typical, and initial, value for long AVO periods is 30. */ longPeriod?: number; /** - * Gets or sets the MarkerCollisionAvoidance + * Gets or sets the MarkerCollisionAvoidance * * Valid values: * "none" No collision avoidance is attempted. @@ -14512,92 +14512,92 @@ interface IgDataChartSeries { markerCollisionAvoidance?: string; /** - * Sets or Gets whether to increase marker fidelity for extreme data shapes that have lots of Y variation over short X intervals. + * Sets or Gets whether to increase marker fidelity for extreme data shapes that have lots of Y variation over short X intervals. */ useHighMarkerFidelity?: boolean; /** - * Gets or sets whether to use use brute force mode. + * Gets or sets whether to use use brute force mode. */ useBruteForce?: boolean; /** - * Gets or sets whether to progressively load the data into the chart. + * Gets or sets whether to progressively load the data into the chart. */ progressiveLoad?: boolean; /** - * Gets or sets whether the chart reacts to mouse move events. + * Gets or sets whether the chart reacts to mouse move events. */ mouseOverEnabled?: boolean; /** - * Gets or sets whether to use squares when halting a render traversal rather than the shape of the coalesced area. + * Gets or sets whether to use squares when halting a render traversal rather than the shape of the coalesced area. */ useSquareCutoffStyle?: boolean; /** - * Gets or sets the density value that maps to the minimum heat color. + * Gets or sets the density value that maps to the minimum heat color. */ heatMinimum?: number; /** - * Gets or sets the value that maps to the maximum heat color. + * Gets or sets the value that maps to the maximum heat color. */ heatMaximum?: number; /** - * Gets or sets the minimum heat color for the density scale. + * Gets or sets the minimum heat color for the density scale. */ heatMinimumColor?: any; /** - * Gets or sets the maximum heat color for the density scale. + * Gets or sets the maximum heat color for the density scale. */ heatMaximumColor?: any; /** - * Gets or sets the series for stacked charts. It should contain array of series objects. Each item in array should represent a series with and it may have most options supported by top-level series object, such as xAxis, yAxis, valueMemberPath, etc. + * Gets or sets the series for stacked charts. It should contain array of series objects. Each item in array should represent a series with and it may have most options supported by top-level series object, such as xAxis, yAxis, valueMemberPath, etc. */ series?: any[]; /** - * Gets or sets whether drop shadow should be enabled for this series. + * Gets or sets whether drop shadow should be enabled for this series. */ isDropShadowEnabled?: boolean; /** - * Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. + * Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. */ useSingleShadow?: boolean; /** - * Gets or sets the color to use for the drop shadow. + * Gets or sets the color to use for the drop shadow. */ shadowColor?: any; /** - * Gets or sets the blur amount to use for the drop shadow. + * Gets or sets the blur amount to use for the drop shadow. */ shadowBlur?: number; /** - * Gets or sets the x offset amount to use for the drop shadow. + * Gets or sets the x offset amount to use for the drop shadow. */ shadowOffsetX?: number; /** - * Gets or sets the y offset amount to use for the drop shadow. + * Gets or sets the y offset amount to use for the drop shadow. */ shadowOffsetY?: number; /** - * Gets or sets if the series should play a transition in animation when the data source is assigned. Note: Transitions are not currently supported for stacked series. + * Gets or sets if the series should play a transition in animation when the data source is assigned. Note: Transitions are not currently supported for stacked series. */ isTransitionInEnabled?: boolean; /** - * Gets or sets the speed to transition in the series data points. + * Gets or sets the speed to transition in the series data points. * * Valid values: * "auto" A speed type is automatically selected. @@ -14609,7 +14609,7 @@ interface IgDataChartSeries { transitionInSpeedType?: string; /** - * Gets or sets the method to transition in the series. Note: Transitions are not currently supported for stacked series. + * Gets or sets the method to transition in the series. Note: Transitions are not currently supported for stacked series. * * Valid values: * "auto" Series transitions in an automatically chosen way. @@ -14636,37 +14636,37 @@ interface IgDataChartSeries { transitionInMode?: string; /** - * Gets or sets the duration of the current series's transition in morph in milliseconds. + * Gets or sets the duration of the current series's transition in morph in milliseconds. */ transitionInDuration?: number; /** - * Gets or sets the corner radius to use for the series, if applicable. + * Gets or sets the corner radius to use for the series, if applicable. */ radius?: number; /** - * Gets or sets the opacity modifier to apply to the area fill shape of the series, if applicable. + * Gets or sets the opacity modifier to apply to the area fill shape of the series, if applicable. */ areaFillOpacity?: number; /** - * Gets or sets whether the series should expect that its data source members need to be called as functions to get their values. + * Gets or sets whether the series should expect that its data source members need to be called as functions to get their values. */ expectFunctions?: boolean; /** - * Gets or sets whether the hover layer should use interpolation to position itself relative the closest values. + * Gets or sets whether the hover layer should use interpolation to position itself relative the closest values. */ useInterpolation?: boolean; /** - * Gets or sets whether the hover layer should skip unknown values when trying to find the closest values. + * Gets or sets whether the hover layer should skip unknown values when trying to find the closest values. */ skipUnknownValues?: boolean; /** - * Gets or sets whether the vertical crosshair portion of the layer should be visible. + * Gets or sets whether the vertical crosshair portion of the layer should be visible. * * Valid values: * "visible" the vertical crosshair portion of the layer should be visible. @@ -14675,7 +14675,7 @@ interface IgDataChartSeries { verticalLineVisibility?: string; /** - * Gets or sets whether the horizontal crosshair portion of the layer should be visible. + * Gets or sets whether the horizontal crosshair portion of the layer should be visible. * * Valid values: * "visible" the horizontal crosshair portion of the layer should be visible. @@ -14684,27 +14684,27 @@ interface IgDataChartSeries { horizontalLineVisibility?: string; /** - * Gets or sets the name of the target series for the layer, if desired. Setting the target series will scope the layer to target just that series. + * Gets or sets the name of the target series for the layer, if desired. Setting the target series will scope the layer to target just that series. */ targetSeries?: string; /** - * Gets or sets the name of the target axis for the layer, if desired. Setting the target axis will scope the layer to target just that axis. + * Gets or sets the name of the target axis for the layer, if desired. Setting the target axis will scope the layer to target just that axis. */ targetAxis?: string; /** - * Gets or sets whether a custom category style is allowed. Setting this to true will case the assigningCategoryStyle event to get fired, if provided. + * Gets or sets whether a custom category style is allowed. Setting this to true will case the assigningCategoryStyle event to get fired, if provided. */ isCustomCategoryStyleAllowed?: boolean; /** - * Gets or sets whether a custom category marker style is allowed. Setting this to true will case the assigningCategoryMarkerStyle event to get fired, if provided. + * Gets or sets whether a custom category marker style is allowed. Setting this to true will case the assigningCategoryMarkerStyle event to get fired, if provided. */ isCustomCategoryMarkerStyleAllowed?: boolean; /** - * Gets or sets value that is used to determine positioning logic for data items which have been consolidated into a single visual element. + * Gets or sets value that is used to determine positioning logic for data items which have been consolidated into a single visual element. * * Valid values: * "maximum" Consolidated items will be positioned using their maximum value. @@ -14716,17 +14716,17 @@ interface IgDataChartSeries { consolidatedColumnVerticalPosition?: string; /** - * Gets or sets whether highlighting should be enabled for the series, if supported. + * Gets or sets whether highlighting should be enabled for the series, if supported. */ isHighlightingEnabled?: boolean; /** - * Gets or sets the width to use for the highlight region if highlighting items in a grid aligned series (line, spline, etc), with a banded shape. + * Gets or sets the width to use for the highlight region if highlighting items in a grid aligned series (line, spline, etc), with a banded shape. */ bandHighlightWidth?: number; /** - * Gets or sets which type of highlight shape to use when highlighting items. + * Gets or sets which type of highlight shape to use when highlighting items. * * Valid values: * "auto" use an automatic highlight type for this series. @@ -14736,7 +14736,7 @@ interface IgDataChartSeries { highlightType?: string; /** - * Gets or sets the Position to apply to the tooltip containers. + * Gets or sets the Position to apply to the tooltip containers. * * Valid values: * "auto" use an automatic position for the category tooltips. @@ -14748,33 +14748,33 @@ interface IgDataChartSeries { tooltipPosition?: string; /** - * Sets the position a cursor position to use instead of the current mouse cursor position for displaying the annotations in this layer. + * Sets the position a cursor position to use instead of the current mouse cursor position for displaying the annotations in this layer. * Should be an object with an x and a y property in world coordinates (ranging from 0 to 1) */ cursorPosition?: any; /** - * Sets if the presence of this layer should disable the default crosshair behavior of the chart, if present. + * Sets if the presence of this layer should disable the default crosshair behavior of the chart, if present. */ isDefaultCrosshairDisabled?: boolean; /** - * Sets if the current layer should take up a brush/ordering index in the series collection to derive its color automatically. + * Sets if the current layer should take up a brush/ordering index in the series collection to derive its color automatically. */ useIndex?: boolean; /** - * Sets if the current layer should have an entry in the legend of the chart. By default annotation layers are not present in the legend. + * Sets if the current layer should have an entry in the legend of the chart. By default annotation layers are not present in the legend. */ useLegend?: boolean; /** - * Sets whether the order of the fragment series should be reversed in the legend. Note: Reversing the legend order is only supported on stacked series. + * Sets whether the order of the fragment series should be reversed in the legend. Note: Reversing the legend order is only supported on stacked series. */ reverseLegendOrder?: boolean; /** - * Gets or sets which type of hit testing the series should use. + * Gets or sets which type of hit testing the series should use. * * Valid values: * "auto" automatically decide the appropriate hit test mode for the series. @@ -14784,7 +14784,7 @@ interface IgDataChartSeries { hitTestMode?: string; /** - * Option for IgDataChartSeries + * Option for IgDataChartSeries */ [optionName: string]: any; } @@ -14795,32 +14795,32 @@ interface TooltipShowingEvent { interface TooltipShowingEventUIParam { /** - * Used to get reference to tooltip DOM element. + * Used to get reference to tooltip DOM element. */ element?: any; /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; } @@ -14831,32 +14831,32 @@ interface TooltipShownEvent { interface TooltipShownEventUIParam { /** - * Used to get reference to tooltip DOM element. + * Used to get reference to tooltip DOM element. */ element?: any; /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; } @@ -14867,32 +14867,32 @@ interface TooltipHidingEvent { interface TooltipHidingEventUIParam { /** - * Used to get reference to tooltip DOM element. + * Used to get reference to tooltip DOM element. */ element?: any; /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; } @@ -14903,32 +14903,32 @@ interface TooltipHiddenEvent { interface TooltipHiddenEventUIParam { /** - * Used to get reference to tooltip DOM element. + * Used to get reference to tooltip DOM element. */ element?: any; /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; } @@ -14946,37 +14946,37 @@ interface SeriesCursorMouseMoveEvent { interface SeriesCursorMouseMoveEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -14987,37 +14987,37 @@ interface SeriesMouseLeftButtonDownEvent { interface SeriesMouseLeftButtonDownEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -15028,37 +15028,37 @@ interface SeriesMouseLeftButtonUpEvent { interface SeriesMouseLeftButtonUpEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -15069,37 +15069,37 @@ interface SeriesMouseMoveEvent { interface SeriesMouseMoveEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -15110,37 +15110,37 @@ interface SeriesMouseEnterEvent { interface SeriesMouseEnterEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -15151,37 +15151,37 @@ interface SeriesMouseLeaveEvent { interface SeriesMouseLeaveEventUIParam { /** - * Used to get reference to current series item object. + * Used to get reference to current series item object. */ item?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get item brush. + * Used to get item brush. */ actualItemBrush?: any; /** - * Used to get series brush. + * Used to get series brush. */ actualSeriesBrush?: any; /** - * Used to get mouse X position. + * Used to get mouse X position. */ positionX?: any; /** - * Used to get mouse Y position. + * Used to get mouse Y position. */ positionY?: any; } @@ -15192,47 +15192,47 @@ interface WindowRectChangedEvent { interface WindowRectChangedEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get new height value. + * Used to get new height value. */ newHeight?: any; /** - * Used to get new left value. + * Used to get new left value. */ newLeft?: any; /** - * Used to get new top value. + * Used to get new top value. */ newTop?: any; /** - * Used to get new top value. + * Used to get new top value. */ newWidth?: any; /** - * Used to get old height value. + * Used to get old height value. */ oldHeight?: any; /** - * Used to get old left value. + * Used to get old left value. */ oldLeft?: any; /** - * Used to get old top value. + * Used to get old top value. */ oldTop?: any; /** - * Used to get old top value. + * Used to get old top value. */ oldWidth?: any; } @@ -15243,47 +15243,47 @@ interface GridAreaRectChangedEvent { interface GridAreaRectChangedEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get new height value. + * Used to get new height value. */ newHeight?: any; /** - * Used to get new left value. + * Used to get new left value. */ newLeft?: any; /** - * Used to get new top value. + * Used to get new top value. */ newTop?: any; /** - * Used to get new top value. + * Used to get new top value. */ newWidth?: any; /** - * Used to get old height value. + * Used to get old height value. */ oldHeight?: any; /** - * Used to get old left value. + * Used to get old left value. */ oldLeft?: any; /** - * Used to get old top value. + * Used to get old top value. */ oldTop?: any; /** - * Used to get old top value. + * Used to get old top value. */ oldWidth?: any; } @@ -15294,7 +15294,7 @@ interface RefreshCompletedEvent { interface RefreshCompletedEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; } @@ -15305,32 +15305,32 @@ interface AxisRangeChangedEvent { interface AxisRangeChangedEventUIParam { /** - * Used to get reference to current chart axis object. + * Used to get reference to current chart axis object. */ axis?: any; /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get new maximum value. + * Used to get new maximum value. */ newMaximumValue?: any; /** - * Used to get new minimum value. + * Used to get new minimum value. */ newMinimumValue?: any; /** - * Used to get old maximum value. + * Used to get old maximum value. */ oldMaximumValue?: any; /** - * Used to get old minimum value. + * Used to get old minimum value. */ oldMinimumValue?: any; } @@ -15341,37 +15341,37 @@ interface TypicalBasedOnEvent { interface TypicalBasedOnEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get the number of positions that should be calculated from the start. + * Used to get the number of positions that should be calculated from the start. */ count?: any; /** - * Used to get the beginning position that should be calculated from. + * Used to get the beginning position that should be calculated from. */ position?: any; /** - * Used to get the supporting calculations to use in the calculation. + * Used to get the supporting calculations to use in the calculation. */ supportingCalculations?: any; /** - * Used to get the data to use for the calculation. + * Used to get the data to use for the calculation. */ dataSource?: any; /** - * Used to specify which columns changing will invalidate the series and cause it to be recalculated. + * Used to specify which columns changing will invalidate the series and cause it to be recalculated. */ basedOn?: any; } @@ -15382,17 +15382,17 @@ interface ProgressiveLoadStatusChangedEvent { interface ProgressiveLoadStatusChangedEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get current status. + * Used to get current status. */ currentStatus?: any; } @@ -15403,64 +15403,64 @@ interface AssigningCategoryStyleEvent { interface AssigningCategoryStyleEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get the start index for the current items. + * Used to get the start index for the current items. */ startIndex?: any; /** - * Used to get the end index for the current items. + * Used to get the end index for the current items. */ endIndex?: any; /** - * Used to tell if you should use the startDate and endDate to know the current items instead of startIndex/endIndex. + * Used to tell if you should use the startDate and endDate to know the current items instead of startIndex/endIndex. */ hasDateRange?: any; startDate?: any; endDate?: any; /** - * Used to get all the items associated with the event (only if necessary). + * Used to get all the items associated with the event (only if necessary). */ getItems?: any; /** - * Used to get or set the fill to use for the current item. + * Used to get or set the fill to use for the current item. */ fill?: any; /** - * Used to get or set the stroke to use for the current item. + * Used to get or set the stroke to use for the current item. */ stroke?: any; /** - * Used to get or set the opacity to use for the current item. + * Used to get or set the opacity to use for the current item. */ opacity?: any; /** - * Used to set if the default highlighting behavior should not run, given that you are handling it in this event. + * Used to set if the default highlighting behavior should not run, given that you are handling it in this event. */ highlightingHandled?: any; /** - * Used to get the maximum highlighted progress across all series. + * Used to get the maximum highlighted progress across all series. */ maxAllSeriesHighlightingProgress?: any; /** - * Used to get the sum of highlighting progtess across all series. + * Used to get the sum of highlighting progtess across all series. */ sumAllSeriesHighlightingProgress?: any; } @@ -15471,115 +15471,115 @@ interface AssigningCategoryMarkerStyleEvent { interface AssigningCategoryMarkerStyleEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get the start index for the current items. + * Used to get the start index for the current items. */ startIndex?: any; /** - * Used to get the end index for the current items. + * Used to get the end index for the current items. */ endIndex?: any; /** - * Used to tell if you should use the startDate and endDate to know the current items instead of startIndex/endIndex. + * Used to tell if you should use the startDate and endDate to know the current items instead of startIndex/endIndex. */ hasDateRange?: any; startDate?: any; endDate?: any; /** - * Used to get all the items associated with the event (only if necessary). + * Used to get all the items associated with the event (only if necessary). */ getItems?: any; /** - * Used to get or set the fill to use for the current item. + * Used to get or set the fill to use for the current item. */ fill?: any; /** - * Used to get or set the stroke to use for the current item. + * Used to get or set the stroke to use for the current item. */ stroke?: any; /** - * Used to get or set the opacity to use for the current item. + * Used to get or set the opacity to use for the current item. */ opacity?: any; /** - * Used to set if the default highlighting behavior should not run, given that you are handling it in this event. + * Used to set if the default highlighting behavior should not run, given that you are handling it in this event. */ highlightingHandled?: any; /** - * Used to get the maximum highlighted progress across all series. + * Used to get the maximum highlighted progress across all series. */ maxAllSeriesHighlightingProgress?: any; /** - * Used to get the sum of highlighting progtess across all series. + * Used to get the sum of highlighting progtess across all series. */ sumAllSeriesHighlightingProgress?: any; } interface IgDataChart { /** - * Gets or sets whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. + * Gets or sets whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. */ isPagePanningAllowed?: boolean; /** - * The channel name to use to sync this chart with other charts. + * The channel name to use to sync this chart with other charts. */ syncChannel?: string; /** - * Whether the chart should be synchronized vertically + * Whether the chart should be synchronized vertically */ synchronizeVertically?: boolean; /** - * Whether the chart should be synchronized horizontally + * Whether the chart should be synchronized horizontally */ synchronizeHorizontally?: boolean; /** - * Gets or sets the cross hair point (in world coordinates) + * Gets or sets the cross hair point (in world coordinates) * Either or both of the crosshair point's X and Y may be set to double.NaN, in which * case the relevant crosshair line is hidden. */ crosshairPoint?: IgDataChartCrosshairPoint; /** - * A rectangle representing the portion of the chart currently in view. + * A rectangle representing the portion of the chart currently in view. * A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in. * The provided object should have numeric properties called left, top, width and height. */ windowRect?: any; /** - * Gets or sets the current Chart's horizontal zoomability. + * Gets or sets the current Chart's horizontal zoomability. */ horizontalZoomable?: boolean; /** - * Gets or sets the current Chart's vertical zoomability. + * Gets or sets the current Chart's vertical zoomability. */ verticalZoomable?: boolean; /** - * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. + * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * * * Valid values: @@ -15589,14 +15589,14 @@ interface IgDataChart { windowResponse?: string; /** - * Sets or gets the minimum width that the window rect is allowed to reach before being clamped. + * Sets or gets the minimum width that the window rect is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. */ windowRectMinWidth?: number; /** - * The visibility of the OverviewPlusDetailPane. + * The visibility of the OverviewPlusDetailPane. * * Valid values: * "visible" The overview pane should be visible. @@ -15605,7 +15605,7 @@ interface IgDataChart { overviewPlusDetailPaneVisibility?: string; /** - * Gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart. + * Gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart. * * Valid values: * "visible" Crosshair should be visible. @@ -15614,12 +15614,12 @@ interface IgDataChart { crosshairVisibility?: string; /** - * Gets or sets the brush used as the background for the current Chart object's plot area. + * Gets or sets the brush used as the background for the current Chart object's plot area. */ plotAreaBackground?: string; /** - * Gets or sets the DefaultInteraction property. The default interaction state defines the chart's response to mouse events. + * Gets or sets the DefaultInteraction property. The default interaction state defines the chart's response to mouse events. * * Valid values: * "none" User gesture will not change the state of the chart. @@ -15629,7 +15629,7 @@ interface IgDataChart { defaultInteraction?: string; /** - * Gets or sets the current Chart's DragModifier property. + * Gets or sets the current Chart's DragModifier property. * * Valid values: * "none" No modifier key is set. @@ -15640,7 +15640,7 @@ interface IgDataChart { dragModifier?: string; /** - * Gets or sets the current Chart's PanModifier property. + * Gets or sets the current Chart's PanModifier property. * * Valid values: * "none" No modifier key is set. @@ -15651,7 +15651,7 @@ interface IgDataChart { panModifier?: string; /** - * Gets or sets the preview rectangle. + * Gets or sets the preview rectangle. * The preview rectangle may be set to Rect.Empty, in which case the visible preview * strokePath is hidden. * The provided object should have numeric properties called left, top, width and height. @@ -15659,31 +15659,31 @@ interface IgDataChart { previewRect?: any; /** - * A number between 0 and 1 determining the position of the horizontal scroll. + * A number between 0 and 1 determining the position of the horizontal scroll. * This property is effectively a shortcut to the X position of the WindowRect property. */ windowPositionHorizontal?: number; /** - * A number between 0 and 1 determining the position of the vertical scroll. + * A number between 0 and 1 determining the position of the vertical scroll. * This property is effectively a shortcut to the Y position of the WindowRect property. */ windowPositionVertical?: number; /** - * A number between 0 and 1 determining the scale of the horizontal zoom. + * A number between 0 and 1 determining the scale of the horizontal zoom. * This property is effectively a shortcut to the Width of the WindowRect property. */ windowScaleHorizontal?: number; /** - * A number between 0 and 1 determining the scale of the vertical zoom. + * A number between 0 and 1 determining the scale of the vertical zoom. * This property is effectively a shortcut to the Height of the WindowRect property. */ windowScaleVertical?: number; /** - * Gets or sets the template to use for circle markers on the chart. + * Gets or sets the template to use for circle markers on the chart. * Defines the marker template used for * series with a marker type of circle. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15691,7 +15691,7 @@ interface IgDataChart { circleMarkerTemplate?: any; /** - * Gets or sets the template to use for triangle markers on the chart. + * Gets or sets the template to use for triangle markers on the chart. * Defines the marker template used for * series with a marker type of triangle. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15699,7 +15699,7 @@ interface IgDataChart { triangleMarkerTemplate?: any; /** - * Gets or sets the template to use for pyramid markers on the chart. + * Gets or sets the template to use for pyramid markers on the chart. * Defines the marker template used for * series with a marker type of pyramid. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15707,7 +15707,7 @@ interface IgDataChart { pyramidMarkerTemplate?: any; /** - * Gets or sets the template to use for square markers on the chart. + * Gets or sets the template to use for square markers on the chart. * Defines the marker template used for * series with a marker type of square. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15715,7 +15715,7 @@ interface IgDataChart { squareMarkerTemplate?: any; /** - * Gets or sets the template to use for diamond markers on the chart. + * Gets or sets the template to use for diamond markers on the chart. * Defines the marker template used for * series with a marker type of diamond. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15723,7 +15723,7 @@ interface IgDataChart { diamondMarkerTemplate?: any; /** - * Gets or sets the template to use for pentagon markers on the chart. + * Gets or sets the template to use for pentagon markers on the chart. * Defines the marker template used for * series with a marker type of pentagon. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15731,7 +15731,7 @@ interface IgDataChart { pentagonMarkerTemplate?: any; /** - * Gets or sets the template to use for hexagon markers on the chart. + * Gets or sets the template to use for hexagon markers on the chart. * Defines the marker template used for * series with a marker type of hexagon. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15739,7 +15739,7 @@ interface IgDataChart { hexagonMarkerTemplate?: any; /** - * Gets or sets the template to use for tetragram markers on the chart. + * Gets or sets the template to use for tetragram markers on the chart. * Defines the marker template used for * series with a marker type of tetragram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15747,7 +15747,7 @@ interface IgDataChart { tetragramMarkerTemplate?: any; /** - * Gets or sets the template to use for pentragram markers on the chart. + * Gets or sets the template to use for pentragram markers on the chart. * Defines the marker template used for * series with a marker type of pentagram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15755,7 +15755,7 @@ interface IgDataChart { pentagramMarkerTemplate?: any; /** - * Gets or sets the template to use for hexagram markers on the chart. + * Gets or sets the template to use for hexagram markers on the chart. * Defines the marker template used for * series with a marker type of hexagram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -15763,42 +15763,42 @@ interface IgDataChart { hexagramMarkerTemplate?: any; /** - * Sets or gets the top margin to use around the chart content in the canvas. + * Sets or gets the top margin to use around the chart content in the canvas. */ topMargin?: number; /** - * Sets or gets the left margin to use around the chart content in the canvas. + * Sets or gets the left margin to use around the chart content in the canvas. */ leftMargin?: number; /** - * Sets or gets the right margin to use around the chart content in the canvas. + * Sets or gets the right margin to use around the chart content in the canvas. */ rightMargin?: number; /** - * Sets or gets the bottom margin to use around the chart content in the canvas. + * Sets or gets the bottom margin to use around the chart content in the canvas. */ bottomMargin?: number; /** - * Sets or gets the automatic width to add when automatically adding margins to the chart. + * Sets or gets the automatic width to add when automatically adding margins to the chart. */ autoMarginWidth?: number; /** - * Sets or gets the automatic height to add when automatically adding margins to the chart. + * Sets or gets the automatic height to add when automatically adding margins to the chart. */ autoMarginHeight?: number; /** - * Gets or sets whether to use a square aspect ratio for the chart. This is locked to true for polar and radial charts. + * Gets or sets whether to use a square aspect ratio for the chart. This is locked to true for polar and radial charts. */ isSquare?: boolean; /** - * Gets or sets the GridMode property. + * Gets or sets the GridMode property. * * Valid values: * "none" No chart grid. @@ -15808,150 +15808,150 @@ interface IgDataChart { gridMode?: string; /** - * Gets or sets the Brushes property. + * Gets or sets the Brushes property. * The brushes property defines the palette from which automatically assigned series brushes are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the MarkerBrushes property. + * Gets or sets the MarkerBrushes property. * The marker brushes property defines the palette from which automatically assigned marker brushes are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ markerBrushes?: any; /** - * Gets or sets the Outlines property. + * Gets or sets the Outlines property. * The outlines property defines the palette from which automatically assigned series outlines are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; /** - * Gets or sets the MarkerOutlines property. + * Gets or sets the MarkerOutlines property. * The marker outlines property defines the palette from which automatically assigned marker outlines are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ markerOutlines?: any; /** - * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * To set both dimensions of the chart simultaneously an object with a width and height property can be provided + * To set both dimensions of the chart simultaneously an object with a width and height property can be provided */ size?: any; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Set to true in order to disable any interactions with the plot surface. + * Set to true in order to disable any interactions with the plot surface. */ isSurfaceInteractionDisabled?: boolean; /** - * Set to true in order to override the default behavior in which series do not animate if an axis range changes + * Set to true in order to override the default behavior in which series do not animate if an axis range changes */ animateSeriesWhenAxisRangeChanges?: boolean; /** - * The title to display for the component. + * The title to display for the component. */ title?: string; /** - * The subtitle to display for the component. + * The subtitle to display for the component. */ subtitle?: string; /** - * The css font property to use for the title. + * The css font property to use for the title. */ titleTextStyle?: string; /** - * The top margin to use for the title. + * The top margin to use for the title. */ titleTopMargin?: number; /** - * The left margin to use for the title. + * The left margin to use for the title. */ titleLeftMargin?: number; /** - * The right margin to use for the title. + * The right margin to use for the title. */ titleRightMargin?: number; /** - * The bottom margin to use for the title. + * The bottom margin to use for the title. */ titleBottomMargin?: number; /** - * The css font property to use for the title. + * The css font property to use for the title. */ subtitleTextStyle?: string; /** - * The top margin to use for the subtitle. + * The top margin to use for the subtitle. */ subtitleTopMargin?: number; /** - * The left margin to use for the subtitle. + * The left margin to use for the subtitle. */ subtitleLeftMargin?: number; /** - * The right margin to use for the subtitle. + * The right margin to use for the subtitle. */ subtitleRightMargin?: number; /** - * The bottom margin to use for the subtitle. + * The bottom margin to use for the subtitle. */ subtitleBottomMargin?: number; /** - * The color to use for the title. + * The color to use for the title. */ titleTextColor?: any; /** - * The color to use for the subtitle. + * The color to use for the subtitle. */ subtitleTextColor?: any; /** - * the horizontal alignment to use for the title. + * the horizontal alignment to use for the title. * * Valid values: * "left" left aligns the title. @@ -15961,7 +15961,7 @@ interface IgDataChart { titleHorizontalAlignment?: string; /** - * the horizontal alignment to use for the subtitle. + * the horizontal alignment to use for the subtitle. * * Valid values: * "left" left aligns the subtitle. @@ -15971,32 +15971,32 @@ interface IgDataChart { subtitleHorizontalAlignment?: string; /** - * The length, in milliseconds of the highlighting transition. + * The length, in milliseconds of the highlighting transition. */ highlightingTransitionDuration?: number; /** - * Sets whether the series viewer should use cached tiles during zooms rather than the default live content. + * Sets whether the series viewer should use cached tiles during zooms rather than the default live content. */ useTiledZooming?: boolean; /** - * Sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. + * Sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. */ preferHigherResolutionTiles?: boolean; /** - * Gets or sets the scaling value used by the main canvas rendering context to apply a scale transform to it. + * Gets or sets the scaling value used by the main canvas rendering context to apply a scale transform to it. */ pixelScalingRatio?: number; /** - * Sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. + * Sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. */ zoomTileCacheSize?: number; /** - * Gets or sets which type of hit testing the series should use. + * Gets or sets which type of hit testing the series should use. * * Valid values: * "auto" automatically decide the appropriate hit test mode for the series. @@ -16008,27 +16008,27 @@ interface IgDataChart { contentHitTestMode?: string; /** - * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. + * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. */ legend?: IgDataChartLegend; /** - * An array of axis objects + * An array of axis objects */ axes?: IgDataChartAxes[]; /** - * An array of series objects + * An array of series objects */ series?: IgDataChartSeries[]; /** - * The swatch used to style this widget + * The swatch used to style this widget */ theme?: string; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -16040,7 +16040,7 @@ interface IgDataChart { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -16052,7 +16052,7 @@ interface IgDataChart { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left a series and the tooltip is about to hide + * Event fired when the mouse has left a series and the tooltip is about to hide * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -16064,7 +16064,7 @@ interface IgDataChart { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -16076,12 +16076,12 @@ interface IgDataChart { tooltipHidden?: TooltipHiddenEvent; /** - * Event fired when the control is displayed on a non HTML5 compliant browser + * Event fired when the control is displayed on a non HTML5 compliant browser */ browserNotSupported?: BrowserNotSupportedEvent; /** - * Occurs when the cursors are moved over a series in this chart. + * Occurs when the cursors are moved over a series in this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16094,7 +16094,7 @@ interface IgDataChart { seriesCursorMouseMove?: SeriesCursorMouseMoveEvent; /** - * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart. + * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16107,7 +16107,7 @@ interface IgDataChart { seriesMouseLeftButtonDown?: SeriesMouseLeftButtonDownEvent; /** - * Occurs when the left mouse button is released while the mouse pointer is over an element of this chart. + * Occurs when the left mouse button is released while the mouse pointer is over an element of this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16120,7 +16120,7 @@ interface IgDataChart { seriesMouseLeftButtonUp?: SeriesMouseLeftButtonUpEvent; /** - * Occurs when the left mouse pointer moves while over an element of this chart. + * Occurs when the left mouse pointer moves while over an element of this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16133,7 +16133,7 @@ interface IgDataChart { seriesMouseMove?: SeriesMouseMoveEvent; /** - * Occurs when the left mouse pointer enters an element of this chart. + * Occurs when the left mouse pointer enters an element of this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16146,7 +16146,7 @@ interface IgDataChart { seriesMouseEnter?: SeriesMouseEnterEvent; /** - * Occurs when the left mouse pointer leaves an element of this chart. + * Occurs when the left mouse pointer leaves an element of this chart. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.chart to get reference to chart object. @@ -16159,7 +16159,7 @@ interface IgDataChart { seriesMouseLeave?: SeriesMouseLeaveEvent; /** - * Occurs just after the current Chart's window rectangle is changed. + * Occurs just after the current Chart's window rectangle is changed. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.newHeight to get new height value. @@ -16174,7 +16174,7 @@ interface IgDataChart { windowRectChanged?: WindowRectChangedEvent; /** - * Occurs just after the current Chart's grid area rectangle is changed. + * Occurs just after the current Chart's grid area rectangle is changed. * The grid area may change as the result of the Chart being resized, or * of an axis being added or changing size, possibly in another Chart. * Function takes arguments evt and ui. @@ -16191,14 +16191,14 @@ interface IgDataChart { gridAreaRectChanged?: GridAreaRectChangedEvent; /** - * Raised when the chart's processing for an update has completed. + * Raised when the chart's processing for an update has completed. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. */ refreshCompleted?: RefreshCompletedEvent; /** - * Event fired when the range of and axis on the chart changes. + * Event fired when the range of and axis on the chart changes. * Function takes arguments evt and ui. * Use ui.axis to get reference to current chart axis object. * Use ui.chart to get reference to chart object. @@ -16210,7 +16210,7 @@ interface IgDataChart { axisRangeChanged?: AxisRangeChangedEvent; /** - * Handle this event in order to specify which columns the Typical price calculation is based on. + * Handle this event in order to specify which columns the Typical price calculation is based on. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.series to get reference to current series object. @@ -16223,7 +16223,7 @@ interface IgDataChart { typicalBasedOn?: TypicalBasedOnEvent; /** - * Event fired when the progressive loading state of the series has changed. + * Event fired when the progressive loading state of the series has changed. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.series to get reference to current series object. @@ -16232,7 +16232,7 @@ interface IgDataChart { progressiveLoadStatusChanged?: ProgressiveLoadStatusChangedEvent; /** - * Event fired to allow you to override the style of items in a category or financial series. Only fires if you set allowCustomCategoryStyle to true for a series. + * Event fired to allow you to override the style of items in a category or financial series. Only fires if you set allowCustomCategoryStyle to true for a series. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.series to get reference to current series object. @@ -16254,7 +16254,7 @@ interface IgDataChart { assigningCategoryStyle?: AssigningCategoryStyleEvent; /** - * Event fired to allow you to override the style of markers for the items in a category or financial series. Only fires if you set allowCustomCategoryMarkerStyle to true for a series. + * Event fired to allow you to override the style of markers for the items in a category or financial series. Only fires if you set allowCustomCategoryMarkerStyle to true for a series. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.series to get reference to current series object. @@ -16276,7 +16276,7 @@ interface IgDataChart { assigningCategoryMarkerStyle?: AssigningCategoryMarkerStyleEvent; /** - * Option for igDataChart + * Option for igDataChart */ [optionName: string]: any; } @@ -16284,17 +16284,17 @@ interface IgDataChartMethods { option(): void; /** - * Returns the element holding the chart. + * Returns the element holding the chart. */ widget(): void; /** - * Returns the ID of parent element holding the chart. + * Returns the ID of parent element holding the chart. */ id(): string; /** - * Exports the chart to a PNG image. + * Exports the chart to a PNG image. * * @param width The width of the image. * @param height The height of the image. @@ -16302,22 +16302,22 @@ interface IgDataChartMethods { exportImage(width?: Object, height?: Object): Object; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Notify the chart that styles it draws colors from may have been updated. + * Notify the chart that styles it draws colors from may have been updated. */ styleUpdated(): Object; /** - * Resets the zoom level of the chart to default. + * Resets the zoom level of the chart to default. */ resetZoom(): Object; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. @@ -16325,7 +16325,7 @@ interface IgDataChartMethods { addItem(item: Object, targetName: string): void; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -16334,7 +16334,7 @@ interface IgDataChartMethods { insertItem(item: Object, index: number, targetName: string): void; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. * @param targetName The name of the series or axis bound to the data source. This is required only when the data is bound to series or axis. If the data is bound to dataSource of igDataChart, the second parameter should not be set. @@ -16342,7 +16342,7 @@ interface IgDataChartMethods { removeItem(index: number, targetName: string): void; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -16351,7 +16351,7 @@ interface IgDataChartMethods { setItem(index: number, item: Object, targetName: string): void; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -16361,16 +16361,16 @@ interface IgDataChartMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -16379,8 +16379,8 @@ interface IgDataChartMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -16389,7 +16389,7 @@ interface IgDataChartMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Notifies the target axis or series that it should scroll the requested data item into view. + * Notifies the target axis or series that it should scroll the requested data item into view. * * @param targetName The name of the axis or series notify. * @param item The data item to bring into view, if possible. @@ -16397,8 +16397,8 @@ interface IgDataChartMethods { scrollIntoView(targetName: string, item: Object): Object; /** - * Notifies the target axis that it should scale the requested value into chart space from axis space. - * For example you can use this method if you want to find where value 50 of the x axis stands scaled to chart's width. + * Notifies the target axis that it should scale the requested value into chart space from axis space. + * For example you can use this method if you want to find where value 50 of the x axis stands scaled to chart's width. * * @param targetName The name of the axis to notify. * @param unscaledValue The value in axis space to translate into chart space. @@ -16406,8 +16406,8 @@ interface IgDataChartMethods { scaleValue(targetName: string, unscaledValue: number): number; /** - * Notifies the target axis that it should unscale the requested value into axis space from chart space. - * For example you can use this method if you want to find what is the value of x axis unscaled from 0 width of the chart. + * Notifies the target axis that it should unscale the requested value into axis space from chart space. + * For example you can use this method if you want to find what is the value of x axis unscaled from 0 width of the chart. * * @param targetName The name of the axis to notify. * @param scaledValue The value in chart space to translate into axis space. @@ -16415,50 +16415,50 @@ interface IgDataChartMethods { unscaleValue(targetName: string, scaledValue: number): number; /** - * For the target axis, if using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels. + * For the target axis, if using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels. * * @param targetName The name of the axis to notify. */ resetCachedEnhancedInterval(targetName: string): Object; /** - * Notifies the target series that something that affects its visual properties has changed and the visual output needs a repaint. + * Notifies the target series that something that affects its visual properties has changed and the visual output needs a repaint. * * @param targetName The name of the series to notify. */ notifyVisualPropertiesChanged(targetName: string): Object; /** - * Forces any pending deferred work to render on the chart before continuing + * Forces any pending deferred work to render on the chart before continuing */ flush(): void; /** - * Exports visual data from the chart to aid in unit testing + * Exports visual data from the chart to aid in unit testing */ exportVisualData(): void; /** - * Gets the actual minimum value of the target numeric or date time axis + * Gets the actual minimum value of the target numeric or date time axis * * @param targetName The name of the axis from which to get the minimum value. */ getActualMinimumValue(targetName: string): void; /** - * Gets the actual maximum value of the target numeric or date time axis + * Gets the actual maximum value of the target numeric or date time axis * * @param targetName The name of the axis from which to get the maximum value. */ getActualMaximumValue(targetName: string): void; /** - * Creates a print preview page with the chart, hiding all other elements on the page. + * Creates a print preview page with the chart, hiding all other elements on the page. */ print(): void; /** - * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. + * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. * * @param targetName The name of the series to render. * @param animate Whether the change should be animated, if possible. @@ -16466,7 +16466,7 @@ interface IgDataChartMethods { renderSeries(targetName: string, animate: boolean): void; /** - * Gets the item item index associated with the specified world position. + * Gets the item item index associated with the specified world position. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16474,7 +16474,7 @@ interface IgDataChartMethods { getItemIndex(targetName: string, worldPoint: Object): number; /** - * Gets the item that is the best match for the specified world coordinates. + * Gets the item that is the best match for the specified world coordinates. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16482,14 +16482,14 @@ interface IgDataChartMethods { getItem(targetName: string, worldPoint: Object): Object; /** - * For a category plotted series, gets the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. + * For a category plotted series, gets the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. * * @param targetName The name of the series to target. */ getItemSpan(targetName: string): number; /** - * If possible, will return the best available main value of the series for a given world coordinate. + * If possible, will return the best available main value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16499,7 +16499,7 @@ interface IgDataChartMethods { getSeriesValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. + * If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16507,7 +16507,7 @@ interface IgDataChartMethods { getSeriesValueBoundingBox(targetName: string, worldPoint: Object): Object; /** - * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for the world position provided. + * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for the world position provided. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16515,7 +16515,7 @@ interface IgDataChartMethods { getSeriesValueFineGrainedBoundingBoxes(targetName: string, worldPoint: Object): Object; /** - * If possible, will return the best available main value position of the series for a given world coordinate. + * If possible, will return the best available main value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16525,7 +16525,7 @@ interface IgDataChartMethods { getSeriesValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available main value position of the series for a given world coordinate. + * If possible, will return the best available main value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. @@ -16535,7 +16535,7 @@ interface IgDataChartMethods { getSeriesValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available main value of the series for a given world coordinate. + * If possible, will return the best available main value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16545,7 +16545,7 @@ interface IgDataChartMethods { getSeriesValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * If possible, will return the best available value bounding box within the series that has the best value match for the given series pixel coordinate. + * If possible, will return the best available value bounding box within the series that has the best value match for the given series pixel coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16553,7 +16553,7 @@ interface IgDataChartMethods { getSeriesValueBoundingBoxFromSeriesPixel(targetName: string, seriesPoint: Object): Object; /** - * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for series pixel position provided. + * If possible, will return the best available value fine grained bounding boxes within the series that have the best value match for series pixel position provided. * * @param targetName The name of the series to target. * @param worldPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16561,7 +16561,7 @@ interface IgDataChartMethods { getSeriesValueFineGrainedBoundingBoxesFromSeriesPixel(targetName: string, worldPoint: Object): Object; /** - * If possible, will return the best available high value of the series for a given world coordinate. + * If possible, will return the best available high value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16571,7 +16571,7 @@ interface IgDataChartMethods { getSeriesHighValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * If possible, will return the best available high value position of the series for a given world coordinate. + * If possible, will return the best available high value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16581,7 +16581,7 @@ interface IgDataChartMethods { getSeriesHighValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available high value position of the series for a given world coordinate. + * If possible, will return the best available high value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. @@ -16591,7 +16591,7 @@ interface IgDataChartMethods { getSeriesHighValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available high value of the series for a given world coordinate. + * If possible, will return the best available high value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16601,7 +16601,7 @@ interface IgDataChartMethods { getSeriesHighValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * If possible, will return the best available low value of the series for a given world coordinate. + * If possible, will return the best available low value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16611,7 +16611,7 @@ interface IgDataChartMethods { getSeriesLowValue(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * If possible, will return the best available low value position of the series for a given world coordinate. + * If possible, will return the best available low value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16621,7 +16621,7 @@ interface IgDataChartMethods { getSeriesLowValuePosition(targetName: string, worldPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available low value position of the series for a given world coordinate. + * If possible, will return the best available low value position of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} that represents a position within the pixel space of the series. @@ -16631,7 +16631,7 @@ interface IgDataChartMethods { getSeriesLowValuePositionFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): Object; /** - * If possible, will return the best available low value of the series for a given world coordinate. + * If possible, will return the best available low value of the series for a given world coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16641,7 +16641,7 @@ interface IgDataChartMethods { getSeriesLowValueFromSeriesPixel(targetName: string, seriesPoint: Object, useInterpolation: boolean, skipUnknowns: boolean): number; /** - * Gets the item item index associated with the specified series pixel coordinate. + * Gets the item item index associated with the specified series pixel coordinate. * * @param targetName The name of the series to target. * @param seriesPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} ) that represents a position in the space of the axes. @@ -16649,7 +16649,7 @@ interface IgDataChartMethods { getItemIndexFromSeriesPixel(targetName: string, seriesPoint: Object): number; /** - * Gets the item that is the best match for the specified world coordinates. + * Gets the item that is the best match for the specified world coordinates. * * @param targetName The name of the series to target. * @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} ) that represents a position in the pixel space of the series. @@ -16657,28 +16657,28 @@ interface IgDataChartMethods { getItemFromSeriesPixel(targetName: string, seriesPoint: Object): Object; /** - * Gets the category offset for a series, if applicable. + * Gets the category offset for a series, if applicable. * * @param targetName The name of the series to target. */ getSeriesOffsetValue(targetName: string): number; /** - * Gets the category width for a series, if applicable. + * Gets the category width for a series, if applicable. * * @param targetName The name of the series to target. */ getSeriesCategoryWidth(targetName: string): number; /** - * Replays the transition in animation for a series, if applicable. + * Replays the transition in animation for a series, if applicable. * * @param targetName The name of the series to target. */ replayTransitionIn(targetName: string): Object; /** - * Simulates a hover interaction over a given point in the viewport of a series. + * Simulates a hover interaction over a given point in the viewport of a series. * * @param targetName The name of the series to target. * @param seriesPoint The point at which to hover. Should have an x property with type number and a y property with type number. @@ -16686,7 +16686,7 @@ interface IgDataChartMethods { simulateHover(targetName: string, seriesPoint: Object): Object; /** - * Moves the cursor point of the target annotation layer to the desired world coordinates. + * Moves the cursor point of the target annotation layer to the desired world coordinates. * * @param targetName The name of the series to target. * @param worldPoint The point to which to move the cursor. Should have an x property with type number and a y property with type number. @@ -16694,17 +16694,17 @@ interface IgDataChartMethods { moveCursorPoint(targetName: string, worldPoint: Object): Object; /** - * Manually starts a tiled zoom if one isn't already running. + * Manually starts a tiled zoom if one isn't already running. */ startTiledZoomingIfNecessary(): void; /** - * Manually ends a tiled zoom if one is running. + * Manually ends a tiled zoom if one is running. */ endTiledZoomingIfRunning(): void; /** - * Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom. + * Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom. */ clearTileZoomCache(): void; } @@ -16714,12 +16714,12 @@ interface JQuery { interface IgPieChartLegend { /** - * The name of the element to turn into a legend. + * The name of the element to turn into a legend. */ element?: string; /** - * Type of the legend. + * Type of the legend. * * Valid values: * "item" Specify the legend as item legend. It displays a legend item for each pie in the igPieChart control. @@ -16728,17 +16728,17 @@ interface IgPieChartLegend { type?: string; /** - * The width of the legend. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ width?: number; /** - * The height of the legend. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ height?: number; /** - * Option for IgPieChartLegend + * Option for IgPieChartLegend */ [optionName: string]: any; } @@ -16749,12 +16749,12 @@ interface SliceClickEvent { interface SliceClickEventUIParam { /** - * Used to get reference to chart object. + * Used to get reference to chart object. */ chart?: any; /** - * Used to get reference to slice object. + * Used to get reference to slice object. */ slice?: any; } @@ -16765,12 +16765,12 @@ interface LabelClickEvent { interface LabelClickEventUIParam { /** - * Used to get reference to the slice object. + * Used to get reference to the slice object. */ item?: any; /** - * Used to determine whether or not the label click should fire slice click event. + * Used to determine whether or not the label click should fire slice click event. */ allowSliceClick?: any; } @@ -16781,17 +16781,17 @@ interface SelectedItemChangingEvent { interface SelectedItemChangingEventUIParam { /** - * Used to get a reference to the current selected data item. + * Used to get a reference to the current selected data item. */ oldItem?: any; /** - * Used to get a reference to the newly selected data item. + * Used to get a reference to the newly selected data item. */ newItem?: any; /** - * Used to stop the selected item from changing. + * Used to stop the selected item from changing. */ cancel?: any; } @@ -16802,12 +16802,12 @@ interface SelectedItemChangedEvent { interface SelectedItemChangedEventUIParam { /** - * Used to get a reference to the previous selected data item. + * Used to get a reference to the previous selected data item. */ oldItem?: any; /** - * Used to get a reference to the current selected data item. + * Used to get a reference to the current selected data item. */ newItem?: any; } @@ -16818,17 +16818,17 @@ interface SelectedItemsChangingEvent { interface SelectedItemsChangingEventUIParam { /** - * Used to get a reference to the current selected data items. + * Used to get a reference to the current selected data items. */ oldItems?: any; /** - * Used to get a reference to the newly selected data items. + * Used to get a reference to the newly selected data items. */ newItems?: any; /** - * Used to stop the selected items from changing. + * Used to stop the selected items from changing. */ cancel?: any; } @@ -16839,69 +16839,69 @@ interface SelectedItemsChangedEvent { interface SelectedItemsChangedEventUIParam { /** - * Used to get a reference to the previous selected data items. + * Used to get a reference to the previous selected data items. */ oldItems?: any; /** - * Used to get a reference to the current selected data items. + * Used to get a reference to the current selected data items. */ newItems?: any; } interface IgPieChart { /** - * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Gets or Sets the property name that contains the values. This option is deprecated - please use `dataValue` instead. + * Gets or Sets the property name that contains the values. This option is deprecated - please use `dataValue` instead. */ valueMemberPath?: string; /** - * Gets or sets the property name that contains the labels. This option is deprecated - please use `dataLabel` instead. + * Gets or sets the property name that contains the labels. This option is deprecated - please use `dataLabel` instead. */ labelMemberPath?: string; /** - * Gets or Sets the property name that contains the values. + * Gets or Sets the property name that contains the values. */ dataValue?: string; /** - * Gets or sets the property name that contains the labels. + * Gets or sets the property name that contains the labels. */ dataLabel?: string; /** - * Gets or sets the position of chart labels. + * Gets or sets the position of chart labels. * * * Valid values: @@ -16914,19 +16914,19 @@ interface IgPieChart { labelsPosition?: string; /** - * Gets or sets the color for labels rendered outside of the pie chart. If no color is provided then + * Gets or sets the color for labels rendered outside of the pie chart. If no color is provided then * the chart will attempt to find the colors in CSS. If that is not available it will use a default color. */ labelOuterColor?: string; /** - * Gets or sets the color for labels rendered inside of the pie chart. If no color is provided then + * Gets or sets the color for labels rendered inside of the pie chart. If no color is provided then * the chart will attempt to find the colors in CSS. If that is not available it will use a default color. */ labelInnerColor?: string; /** - * Gets or sets the type of selection the pie chart allows. + * Gets or sets the type of selection the pie chart allows. * * * Valid values: @@ -16937,19 +16937,19 @@ interface IgPieChart { selectionMode?: string; /** - * Gets or sets the currently selected data item. If a different data item is provided the pie chart + * Gets or sets the currently selected data item. If a different data item is provided the pie chart * will select the slice associated with the new item. */ selectedItem?: any; /** - * Gets or sets the currently selected data items. Adding or removing data items from this array will + * Gets or sets the currently selected data items. Adding or removing data items from this array will * select or deselect the slices associated with those items. */ selectedItems?: any[]; /** - * Gets or sets whether the leader lines are visible. + * Gets or sets whether the leader lines are visible. * * * Valid values: @@ -16959,7 +16959,7 @@ interface IgPieChart { leaderLineVisibility?: string; /** - * Gets or sets what type of leader lines will be used for the outside end labels. + * Gets or sets what type of leader lines will be used for the outside end labels. * * * Valid values: @@ -16970,17 +16970,17 @@ interface IgPieChart { leaderLineType?: string; /** - * Gets or sets the margin between a label and the end of its leader line. + * Gets or sets the margin between a label and the end of its leader line. */ leaderLineMargin?: number; /** - * Gets or sets the threshold value that determines if slices are grouped into the Others slice. + * Gets or sets the threshold value that determines if slices are grouped into the Others slice. */ othersCategoryThreshold?: number; /** - * Gets or sets the function to use to transform a pie slice data context into a label for the slice. Function takes one argument of type object. + * Gets or sets the function to use to transform a pie slice data context into a label for the slice. Function takes one argument of type object. * Use context.item to get the item associated with the slice, if any. * Use context.outline to get the outline brush used to paint the slice. * Use context.itemLabel to get the label object that would be used for the slice. @@ -16991,12 +16991,12 @@ interface IgPieChart { formatLabel?: Function; /** - * Gets or sets a style object that can be used to override the style settings on the others category slice. + * Gets or sets a style object that can be used to override the style settings on the others category slice. */ othersCategoryStyle?: any; /** - * Gets or sets whether to use numeric or percent-based threshold value. + * Gets or sets whether to use numeric or percent-based threshold value. * * Valid values: * "number" Data value is compared directly to the value of OthersCategoryThreshold. @@ -17005,70 +17005,70 @@ interface IgPieChart { othersCategoryType?: string; /** - * Gets or sets the label of the Others slice. + * Gets or sets the label of the Others slice. */ othersCategoryText?: string; /** - * Determines how much the exploded slice is offset from the center. Value between 0 and 1. + * Determines how much the exploded slice is offset from the center. Value between 0 and 1. */ explodedRadius?: number; /** - * Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. + * Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. */ radiusFactor?: number; /** - * Gets or sets whether the slices can be selected. + * Gets or sets whether the slices can be selected. */ allowSliceSelection?: boolean; /** - * Gets or sets whether the slices can be exploded. + * Gets or sets whether the slices can be exploded. */ allowSliceExplosion?: boolean; /** - * Gets or sets the collection of exploded slice indices. + * Gets or sets the collection of exploded slice indices. * Should be an array of integers that indicate the indexes of the slices to explode. */ explodedSlices?: any[]; /** - * Sets the collection of selected slice indices. + * Sets the collection of selected slice indices. * Should be an array of integers that indicate the indexes of the slices to select. */ selectedSlices?: any[]; /** - * Whether the chart should render a tooltip. + * Whether the chart should render a tooltip. */ showTooltip?: boolean; /** - * The name of template or the template itself that chart tooltip will use to render. + * The name of template or the template itself that chart tooltip will use to render. */ tooltipTemplate?: string; /** - * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. + * Can be any valid options accepted by $.ig.ChartLegend, or an instance of an $.ig.ChartLegend itself. */ legend?: IgPieChartLegend; /** - * Gets or sets the pixel amount, by which the labels are offset from the edge of the slices. + * Gets or sets the pixel amount, by which the labels are offset from the edge of the slices. */ labelExtent?: number; /** - * Gets or sets the starting angle of the chart. + * Gets or sets the starting angle of the chart. * The default zero value is equivalent to 3 o'clock. */ startAngle?: number; /** - * Gets or sets the rotational direction of the chart. + * Gets or sets the rotational direction of the chart. * * * Valid values: @@ -17078,26 +17078,26 @@ interface IgPieChart { sweepDirection?: string; /** - * Gets or sets the style used when a slice is selected. + * Gets or sets the style used when a slice is selected. */ selectedStyle?: any; /** - * Gets or sets the Brushes property. + * Gets or sets the Brushes property. * The brushes property defines the palette from which automatically assigned slice brushes are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the Outlines property. + * Gets or sets the Outlines property. * The Outlines property defines the palette from which automatically assigned slice outlines are selected. * The value provided should be an array of css color strings. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; /** - * Gets or sets the LegendItemTemplate property. + * Gets or sets the LegendItemTemplate property. * The legend item control content is created according to the LegendItemTemplate on-demand by * the chart object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -17105,7 +17105,7 @@ interface IgPieChart { legendItemTemplate?: any; /** - * Gets or sets the LegendItemBadgeTemplate property. + * Gets or sets the LegendItemBadgeTemplate property. * The legend item badge is created according to the LegendItemBadgeTemplate on-demand by * the chart object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -17113,17 +17113,17 @@ interface IgPieChart { legendItemBadgeTemplate?: any; /** - * Overrides the style used for text in the pie chart. + * Overrides the style used for text in the pie chart. */ textStyle?: string; /** - * The swatch used to style this widget + * The swatch used to style this widget */ theme?: string; /** - * Event fired when the mouse has hovered on an element long enough to display a tooltip + * Event fired when the mouse has hovered on an element long enough to display a tooltip * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current pie chart item. @@ -17132,7 +17132,7 @@ interface IgPieChart { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current pie chart item. @@ -17141,7 +17141,7 @@ interface IgPieChart { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left an element and the tooltip is about to hide + * Event fired when the mouse has left an element and the tooltip is about to hide * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current pie chart item. @@ -17150,7 +17150,7 @@ interface IgPieChart { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current pie chart item. @@ -17159,12 +17159,12 @@ interface IgPieChart { tooltipHidden?: TooltipHiddenEvent; /** - * Event fired when the control is displayed on a non HTML5 compliant browser + * Event fired when the control is displayed on a non HTML5 compliant browser */ browserNotSupported?: BrowserNotSupportedEvent; /** - * Raised when the slice is clicked. + * Raised when the slice is clicked. * Function takes arguments evt and ui. * Use ui.chart to get reference to chart object. * Use ui.slice to get reference to slice object. @@ -17175,7 +17175,7 @@ interface IgPieChart { sliceClick?: SliceClickEvent; /** - * Raised when a slice's label is clicked. + * Raised when a slice's label is clicked. * Function takes arguments evt and ui. * Use ui.item to get reference to the slice object. * Use ui.allowSliceClick to determine whether or not the label click should fire slice click event. @@ -17183,7 +17183,7 @@ interface IgPieChart { labelClick?: LabelClickEvent; /** - * Event fired when the selectedItem option is about to change. + * Event fired when the selectedItem option is about to change. * Function takes arguments evt and ui. * Use ui.oldItem to get a reference to the current selected data item. * Use ui.newItem to get a reference to the newly selected data item. @@ -17192,7 +17192,7 @@ interface IgPieChart { selectedItemChanging?: SelectedItemChangingEvent; /** - * Event fired when the selectedItem option has changed. + * Event fired when the selectedItem option has changed. * Function takes arguments evt and ui. * Use ui.oldItem to get a reference to the previous selected data item. * Use ui.newItem to get a reference to the current selected data item. @@ -17200,7 +17200,7 @@ interface IgPieChart { selectedItemChanged?: SelectedItemChangedEvent; /** - * Event fired when the selectedItems array is about to change. + * Event fired when the selectedItems array is about to change. * Function takes arguments evt and ui. * Use ui.oldItems to get a reference to the current selected data items. * Use ui.newItems to get a reference to the newly selected data items. @@ -17209,7 +17209,7 @@ interface IgPieChart { selectedItemsChanging?: SelectedItemsChangingEvent; /** - * Event fired when the selectedItems array has changed. + * Event fired when the selectedItems array has changed. * Function takes arguments evt and ui. * Use ui.oldItems to get a reference to the previous selected data items. * Use ui.newItems to get a reference to the current selected data items. @@ -17217,7 +17217,7 @@ interface IgPieChart { selectedItemsChanged?: SelectedItemsChangedEvent; /** - * Option for igPieChart + * Option for igPieChart */ [optionName: string]: any; } @@ -17225,14 +17225,14 @@ interface IgPieChartMethods { option(): void; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item the new item that will be added to the data source. */ addItem(item: Object): void; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that will be inserted in the data source. * @param index The index in the data source where the new item will be inserted. @@ -17240,14 +17240,14 @@ interface IgPieChartMethods { insertItem(item: Object, index: number): void; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): void; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index in the data source that we want to change. * @param item the new item that we want to set in the data source. @@ -17255,7 +17255,7 @@ interface IgPieChartMethods { setItem(index: number, item: Object): void; /** - * Exports the chart to a PNG image. + * Exports the chart to a PNG image. * * @param width The width of the image. * @param height The height of the image. @@ -17263,27 +17263,27 @@ interface IgPieChartMethods { exportImage(width?: Object, height?: Object): Object; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Returns the ID of parent element holding the chart. + * Returns the ID of parent element holding the chart. */ id(): string; /** - * Returns the element holding the chart. + * Returns the element holding the chart. */ widget(): void; /** - * Creates a print preview page with the chart, hiding all other elements on the page. + * Creates a print preview page with the chart, hiding all other elements on the page. */ print(): void; /** - * Exports visual data from the pie chart to aid in unit testing + * Exports visual data from the pie chart to aid in unit testing */ exportVisualData(): void; } @@ -19733,32 +19733,32 @@ interface LegendItemMouseLeftButtonDownEvent { interface LegendItemMouseLeftButtonDownEventUIParam { /** - * Used to get reference to current legend object. + * Used to get reference to current legend object. */ legend?: any; /** - * Used to get reference to chart owner object. + * Used to get reference to chart owner object. */ chart?: any; /** - * Used to get reference to current series owner object. + * Used to get reference to current series owner object. */ series?: any; /** - * Used to get legend item brush. + * Used to get legend item brush. */ actualItemBrush?: any; /** - * Used to get series owner brush. + * Used to get series owner brush. */ actualSeriesBrush?: any; /** - * Used to get reference to chart item related to event. + * Used to get reference to chart item related to event. */ item?: any; } @@ -19769,32 +19769,32 @@ interface LegendItemMouseLeftButtonUpEvent { interface LegendItemMouseLeftButtonUpEventUIParam { /** - * Used to get reference to current legend object. + * Used to get reference to current legend object. */ legend?: any; /** - * Used to get reference to chart owner object. + * Used to get reference to chart owner object. */ chart?: any; /** - * Used to get reference to current series owner object. + * Used to get reference to current series owner object. */ series?: any; /** - * Used to get legend item brush. + * Used to get legend item brush. */ actualItemBrush?: any; /** - * Used to get series owner brush. + * Used to get series owner brush. */ actualSeriesBrush?: any; /** - * Used to get reference to chart item related to event. + * Used to get reference to chart item related to event. */ item?: any; } @@ -19805,32 +19805,32 @@ interface LegendItemMouseEnterEvent { interface LegendItemMouseEnterEventUIParam { /** - * Used to get reference to current legend object. + * Used to get reference to current legend object. */ legend?: any; /** - * Used to get reference to chart owner object. + * Used to get reference to chart owner object. */ chart?: any; /** - * Used to get reference to current series owner object. + * Used to get reference to current series owner object. */ series?: any; /** - * Used to get legend item brush. + * Used to get legend item brush. */ actualItemBrush?: any; /** - * Used to get series owner brush. + * Used to get series owner brush. */ actualSeriesBrush?: any; /** - * Used to get reference to chart item related to event. + * Used to get reference to chart item related to event. */ item?: any; } @@ -19841,39 +19841,39 @@ interface LegendItemMouseLeaveEvent { interface LegendItemMouseLeaveEventUIParam { /** - * Used to get reference to current legend object. + * Used to get reference to current legend object. */ legend?: any; /** - * Used to get reference to chart owner object. + * Used to get reference to chart owner object. */ chart?: any; /** - * Used to get reference to current series owner object. + * Used to get reference to current series owner object. */ series?: any; /** - * Used to get legend item brush. + * Used to get legend item brush. */ actualItemBrush?: any; /** - * Used to get series owner brush. + * Used to get series owner brush. */ actualSeriesBrush?: any; /** - * Used to get reference to chart item related to event. + * Used to get reference to chart item related to event. */ item?: any; } interface IgChartLegend { /** - * Type of the legend. + * Type of the legend. * * Valid values: * "item" Specify the legend as item legend. It displays a legend item for each pie in the igPieChart control. @@ -19883,22 +19883,22 @@ interface IgChartLegend { type?: string; /** - * The width of the legend. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the legend. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the legend. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * The swatch used to style this widget + * The swatch used to style this widget */ theme?: string; /** - * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this legend. + * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this legend. * Function takes arguments evt and ui. * Use ui.legend to get reference to current legend object. * Use ui.chart to get reference to chart owner object. @@ -19910,7 +19910,7 @@ interface IgChartLegend { legendItemMouseLeftButtonDown?: LegendItemMouseLeftButtonDownEvent; /** - * Occurs when the left mouse button is released while the mouse pointer is over an element of this legend. + * Occurs when the left mouse button is released while the mouse pointer is over an element of this legend. * Function takes arguments evt and ui. * Use ui.legend to get reference to current legend object. * Use ui.chart to get reference to chart owner object. @@ -19922,7 +19922,7 @@ interface IgChartLegend { legendItemMouseLeftButtonUp?: LegendItemMouseLeftButtonUpEvent; /** - * Occurs when the left mouse pointer enters an element of this legend. + * Occurs when the left mouse pointer enters an element of this legend. * Function takes arguments evt and ui. * Use ui.legend to get reference to current legend object. * Use ui.chart to get reference to chart owner object. @@ -19934,7 +19934,7 @@ interface IgChartLegend { legendItemMouseEnter?: LegendItemMouseEnterEvent; /** - * Occurs when the left mouse pointer leaves an element of this legend. + * Occurs when the left mouse pointer leaves an element of this legend. * Function takes arguments evt and ui. * Use ui.legend to get reference to current legend object. * Use ui.chart to get reference to chart owner object. @@ -19946,7 +19946,7 @@ interface IgChartLegend { legendItemMouseLeave?: LegendItemMouseLeaveEvent; /** - * Option for igChartLegend + * Option for igChartLegend */ [optionName: string]: any; } @@ -19954,17 +19954,17 @@ interface IgChartLegendMethods { exportVisualData(): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Returns the element holding the legend. + * Returns the element holding the legend. */ widget(): void; /** - * Returns the ID of the DOM element holding the legend. + * Returns the ID of the DOM element holding the legend. */ id(): string; } @@ -20141,28 +20141,28 @@ interface ColorSelectedEvent { interface ColorSelectedEventUIParam { /** - * Used to get a reference to the color object. + * Used to get a reference to the color object. */ color?: any; } interface IgColorPicker { /** - * Gets/Sets the default colors. Default colors are the ones displayed in the upper table of the color picker. + * Gets/Sets the default colors. Default colors are the ones displayed in the upper table of the color picker. * The array should contain arrays that contain the color values for every next row. * */ colors?: string; /** - * Gets/Sets the standard colors. Standard colors are the ones displayed in the color picker bottom, + * Gets/Sets the standard colors. Standard colors are the ones displayed in the color picker bottom, * visually separated from the default colors. The array should contain the color values. * */ standardColors?: any[]; /** - * The event is fired when a color is selected. + * The event is fired when a color is selected. * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. @@ -20170,41 +20170,41 @@ interface IgColorPicker { colorSelected?: ColorSelectedEvent; /** - * Option for igColorPicker + * Option for igColorPicker */ [optionName: string]: any; } interface IgColorPickerMethods { /** - * Gets a reference to the div element of the color table + * Gets a reference to the div element of the color table */ colorTable(): Object; /** - * Gets a reference to the div element with the default or custom colors table. + * Gets a reference to the div element with the default or custom colors table. */ customColorTable(): Object; /** - * Returns the div element with the standard color table. + * Returns the div element with the standard color table. */ standardColorsTable(): Object; /** - * Gets the color for an element from the color picker in RGB format. + * Gets the color for an element from the color picker in RGB format. * * @param $element A jQuery element in the color picker from which the color will be retrieved. */ colorFromElement($element: Object): string; /** - * Returns the hexademical string of the currently selected color in the color picker. Returns null if no color is selected. + * Returns the hexademical string of the currently selected color in the color picker. Returns null if no color is selected. * @return string|null Returns the selected color if available. Null if no color is selected. */ selectedColor(): string; /** - * Select a color. + * Select a color. * * @param color The #RGB value of the color to be selected. */ @@ -20283,7 +20283,7 @@ interface ClickEvent { interface ClickEventUIParam { /** - * Used to get a reference the igSplitButton element. + * Used to get a reference the igSplitButton element. */ item?: any; } @@ -20294,7 +20294,7 @@ interface ExpandedEvent { interface ExpandedEventUIParam { /** - * Used to get a reference the igSplitButton. + * Used to get a reference the igSplitButton. */ owner?: any; } @@ -20305,7 +20305,7 @@ interface ExpandingEvent { interface ExpandingEventUIParam { /** - * Used to get a reference the igSplitButton. + * Used to get a reference the igSplitButton. */ owner?: any; } @@ -20316,7 +20316,7 @@ interface CollapsedEvent { interface CollapsedEventUIParam { /** - * Used to get a reference the igSplitButton. + * Used to get a reference the igSplitButton. */ owner?: any; } @@ -20327,44 +20327,44 @@ interface CollapsingEvent { interface CollapsingEventUIParam { /** - * Used to get a reference the igSplitButton. + * Used to get a reference the igSplitButton. */ owner?: any; } interface IgColorPickerSplitButton { /** - * Button items. + * Button items. * */ items?: any[]; /** - * Gets/sets the button default color value. + * Gets/sets the button default color value. * */ defaultColor?: string; /** - * If this option is set to true, the igColorPickerSplitButton will be rendered with an icon. + * If this option is set to true, the igColorPickerSplitButton will be rendered with an icon. * */ hasDefaultIcon?: boolean; /** - * Default button item name. + * Default button item name. * */ defaultItemName?: string; /** - * Specifies whether the default button will be switched when another button is selected. + * Specifies whether the default button will be switched when another button is selected. * */ swapDefaultEnabled?: boolean; /** - * Event fired when the button is clicked. + * Event fired when the button is clicked. * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. @@ -20372,7 +20372,7 @@ interface IgColorPickerSplitButton { click?: ClickEvent; /** - * Event fired after the button is expanded. + * Event fired after the button is expanded. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -20380,7 +20380,7 @@ interface IgColorPickerSplitButton { expanded?: ExpandedEvent; /** - * Event fired before a button item is expanded. + * Event fired before a button item is expanded. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -20388,7 +20388,7 @@ interface IgColorPickerSplitButton { expanding?: ExpandingEvent; /** - * Event fired after the button is collapsed. + * Event fired after the button is collapsed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -20396,7 +20396,7 @@ interface IgColorPickerSplitButton { collapsed?: CollapsedEvent; /** - * Event fired before a button item is collapsed. + * Event fired before a button item is collapsed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -20404,39 +20404,39 @@ interface IgColorPickerSplitButton { collapsing?: CollapsingEvent; /** - * Option for igColorPickerSplitButton + * Option for igColorPickerSplitButton */ [optionName: string]: any; } interface IgColorPickerSplitButtonMethods { /** - * Sets the color of the split button + * Sets the color of the split button * * @param color The color value to be set. */ setColor(color: string): Object; /** - * Collapse the widget. + * Collapse the widget. * * @param e */ collapse(e: Object): Object; /** - * Expands the widget. + * Expands the widget. * * @param e */ expand(e: Object): Object; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): Object; /** - * Switch to given igToolbar button. + * Switch to given igToolbar button. * * @param button . The button jQuery element. */ @@ -20444,7 +20444,7 @@ interface IgColorPickerSplitButtonMethods { widget(): void; /** - * Toggle widget state between collapsed and expanded. + * Toggle widget state between collapsed and expanded. * * @param e The igSplitButton to be expanded/collapsed. */ @@ -20630,63 +20630,63 @@ interface JQuery { } interface IgComboLoadOnDemandSettings { /** - * Gets/Sets option to enable load on demand. + * Gets/Sets option to enable load on demand. * */ enabled?: boolean; /** - * Gets/Sets number of records loaded on each request. + * Gets/Sets number of records loaded on each request. * */ pageSize?: number; /** - * Option for IgComboLoadOnDemandSettings + * Option for IgComboLoadOnDemandSettings */ [optionName: string]: any; } interface IgComboMultiSelection { /** - * Set enabled to true to turn multi selection on. Set to true by default when target element for the combo is a select with the multiple attribute set. + * Set enabled to true to turn multi selection on. Set to true by default when target element for the combo is a select with the multiple attribute set. * */ enabled?: boolean; /** - * Set addWithKeyModifier to true to disable the additive selection, then additive selection can be done by ctrl + mouse click / enter. + * Set addWithKeyModifier to true to disable the additive selection, then additive selection can be done by ctrl + mouse click / enter. * */ addWithKeyModifier?: boolean; /** - * Set showCheckboxes to true to render check boxes in front of each drop down item. + * Set showCheckboxes to true to render check boxes in front of each drop down item. * */ showCheckboxes?: boolean; /** - * Use itemSeparator to set what string to be rendered between items in field. + * Use itemSeparator to set what string to be rendered between items in field. * */ itemSeparator?: string; /** - * Option for IgComboMultiSelection + * Option for IgComboMultiSelection */ [optionName: string]: any; } interface IgComboGrouping { /** - * Gets/Sets name of column by which the records will be grouped. Setting this option enables the grouping. + * Gets/Sets name of column by which the records will be grouped. Setting this option enables the grouping. * */ key?: string; /** - * Specifies the sort order - ascending or descending. + * Specifies the sort order - ascending or descending. * * * Valid values: @@ -20696,26 +20696,26 @@ interface IgComboGrouping { dir?: string; /** - * Option for IgComboGrouping + * Option for IgComboGrouping */ [optionName: string]: any; } interface IgComboInitialSelectedItem { /** - * Optional="true" Index of item in the list. The index should be greater than -1 and less than the count of the [items](ui.igcombo#methods:items) in the list (rows in dataSource). + * Optional="true" Index of item in the list. The index should be greater than -1 and less than the count of the [items](ui.igcombo#methods:items) in the list (rows in dataSource). * */ index?: number; /** - * Optional="true" Value matching the [valueKey](ui.igcombo#options:valueKey) property of the item. + * Optional="true" Value matching the [valueKey](ui.igcombo#options:valueKey) property of the item. * */ value?: any; /** - * Option for IgComboInitialSelectedItem + * Option for IgComboInitialSelectedItem */ [optionName: string]: any; } @@ -20726,12 +20726,12 @@ interface RenderedEvent { interface RenderedEventUIParam { /** - * Used to get a reference to the combo performing rendering. + * Used to get a reference to the combo performing rendering. */ owner?: any; /** - * Used to get a reference to the main/top combo element. + * Used to get a reference to the main/top combo element. */ element?: any; } @@ -20742,12 +20742,12 @@ interface FilteringEvent { interface FilteringEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). + * Used to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). */ expression?: any; } @@ -20758,12 +20758,12 @@ interface FilteredEvent { interface FilteredEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain a jquery reference to the rendered filtered elements. + * Used to obtain a jquery reference to the rendered filtered elements. */ elements?: any; } @@ -20774,12 +20774,12 @@ interface ItemsRenderingEvent { interface ItemsRenderingEventUIParam { /** - * Used to get a reference to the combo performing rendering. + * Used to get a reference to the combo performing rendering. */ owner?: any; /** - * Used to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. + * Used to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. */ dataSource?: any; } @@ -20790,12 +20790,12 @@ interface ItemsRenderedEvent { interface ItemsRenderedEventUIParam { /** - * Used to get a reference to the combo performing rendering. + * Used to get a reference to the combo performing rendering. */ owner?: any; /** - * Used to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. + * Used to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. */ dataSource?: any; } @@ -20806,12 +20806,12 @@ interface DropDownOpeningEvent { interface DropDownOpeningEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to jquery DOM element which represents drop down list container. + * Used to obtain reference to jquery DOM element which represents drop down list container. */ list?: any; } @@ -20822,12 +20822,12 @@ interface DropDownOpenedEvent { interface DropDownOpenedEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to jquery DOM element which represents drop down list container. + * Used to obtain reference to jquery DOM element which represents drop down list container. */ list?: any; } @@ -20838,12 +20838,12 @@ interface DropDownClosingEvent { interface DropDownClosingEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to jquery DOM element which represents drop down list container. + * Used to obtain reference to jquery DOM element which represents drop down list container. */ list?: any; } @@ -20854,12 +20854,12 @@ interface DropDownClosedEvent { interface DropDownClosedEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to jquery DOM element which represents drop down list container. + * Used to obtain reference to jquery DOM element which represents drop down list container. */ list?: any; } @@ -20870,17 +20870,17 @@ interface SelectionChangingEvent { interface SelectionChangingEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to array of the selected items before the new selection has happened. That can be null. + * Used to obtain reference to array of the selected items before the new selection has happened. That can be null. */ currentItems?: any; /** - * Used to obtain reference to array of all items that will be selected after the selection finish. That can be null. + * Used to obtain reference to array of all items that will be selected after the selection finish. That can be null. */ items?: any; } @@ -20891,36 +20891,36 @@ interface SelectionChangedEvent { interface SelectionChangedEventUIParam { /** - * Used to obtain reference to igCombo. + * Used to obtain reference to igCombo. */ owner?: any; /** - * Used to obtain reference to array of new selected items. That can be null. + * Used to obtain reference to array of new selected items. That can be null. */ items?: any; /** - * Used to obtain reference to array of old selected items. That can be null. + * Used to obtain reference to array of old selected items. That can be null. */ oldItems?: any; } interface IgCombo { /** - * Gets/Sets the width of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. + * Gets/Sets the width of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * */ width?: string|number; /** - * Gets/Sets height of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. + * Gets/Sets height of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * */ height?: string|number; /** - * Gets/Sets the width of drop-down list in pixels. + * Gets/Sets the width of drop-down list in pixels. * * * Valid values: @@ -20930,39 +20930,39 @@ interface IgCombo { dropDownWidth?: string|number; /** - * Gets/Sets a valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an [$.ig.DataSource](ig.datasource) itself. + * Gets/Sets a valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an [$.ig.DataSource](ig.datasource) itself. * Note: if it is set to string and [dataSourceType](ui.igcombo#options:dataSourceType) option is not set, then [$.ig.JSONDataSource](ig.jsondatasource) is used. * */ dataSource?: any; /** - * Sets data source type (such as "json", "xml", etc). Please refer to the documentation of [$.ig.DataSource](ig.datasource) and its [type](ig.datasource#options:settings.type) property. + * Sets data source type (such as "json", "xml", etc). Please refer to the documentation of [$.ig.DataSource](ig.datasource) and its [type](ig.datasource#options:settings.type) property. * */ dataSourceType?: string; /** - * Sets URL which is used for sending JSON on request for remote filtering (MVC for example). That option is required when [load on demand](ui.igcombo#options:loadOnDemandSettings) is + * Sets URL which is used for sending JSON on request for remote filtering (MVC for example). That option is required when [load on demand](ui.igcombo#options:loadOnDemandSettings) is * [enabled](ui.igcombo#options:loadOnDemandSettings.enabled) and its [type](ui.igcombo#options:filteringType) is remote. * */ dataSourceUrl?: string; /** - * See [$.ig.DataSource](ig.datasource) property in the response specifying the total number of records on the server. + * See [$.ig.DataSource](ig.datasource) property in the response specifying the total number of records on the server. * */ responseTotalRecCountKey?: string; /** - * See [$.ig.DataSource](ig.datasource) This is basically the property in the response where data records are held, if the response is wrapped. + * See [$.ig.DataSource](ig.datasource) This is basically the property in the response where data records are held, if the response is wrapped. * */ responseDataKey?: string; /** - * Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType. + * Response type when a URL is set as the data source. See http://api.jquery.com/jQuery.ajax/ => dataType. * * * Valid values: @@ -20976,44 +20976,44 @@ interface IgCombo { responseDataType?: string; /** - * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType. + * Content type of the response. See http://api.jquery.com/jQuery.ajax/ => contentType. * */ responseContentType?: string; /** - * Specifies the HTTP verb to be used to issue the request. + * Specifies the HTTP verb to be used to issue the request. * */ requestType?: string; /** - * Gets/Sets name of column which contains the "value". If it is missing, then the name of first column will be used. + * Gets/Sets name of column which contains the "value". If it is missing, then the name of first column will be used. * */ valueKey?: string; /** - * Gets/Sets name of column which contains the displayed text. If it is missing, then [valueKey](ui.igcombo#options:valueKey) option will be used. + * Gets/Sets name of column which contains the displayed text. If it is missing, then [valueKey](ui.igcombo#options:valueKey) option will be used. * */ textKey?: string; /** - * Gets/Sets a template used to render an item in list. The igCombo utilizes igTemplating for generating node content templates. + * Gets/Sets a template used to render an item in list. The igCombo utilizes igTemplating for generating node content templates. * More info on the templating engine can be found here: http://www.igniteui.com/help/infragistics-templating-engine. * */ itemTemplate?: string; /** - * Gets/Sets template used to render a header in the drop-down list. The template is rendered inside of a DIV html element. + * Gets/Sets template used to render a header in the drop-down list. The template is rendered inside of a DIV html element. * */ headerTemplate?: string; /** - * Gets/Sets template used to render a footer in the drop-down list. + * Gets/Sets template used to render a footer in the drop-down list. * Notes: * 1. The template is rendered inside of DIV html element. * 2. The following variables can be used: @@ -21026,32 +21026,32 @@ interface IgCombo { footerTemplate?: string; /** - * Gets/Sets the name of a hidden INPUT element, which is used when submitting data. Its value will be set to the values of the selected items valueKeys separated by ',' character on any change in igCombo. If the combo element has 'name' attribute and this option is not set, the 'name' attribute will be used for the input name. + * Gets/Sets the name of a hidden INPUT element, which is used when submitting data. Its value will be set to the values of the selected items valueKeys separated by ',' character on any change in igCombo. If the combo element has 'name' attribute and this option is not set, the 'name' attribute will be used for the input name. * */ inputName?: string; /** - * Gets/Sets show drop-down list animation duration in milliseconds. + * Gets/Sets show drop-down list animation duration in milliseconds. * */ animationShowDuration?: number; /** - * Gets/Sets hide drop-down list animation duration in milliseconds. + * Gets/Sets hide drop-down list animation duration in milliseconds. * */ animationHideDuration?: number; /** - * If set to true, the container of the drop-down list is appended to the body. + * If set to true, the container of the drop-down list is appended to the body. * If set to false, it is appended to the parent element of the combo. * */ dropDownAttachedToBody?: boolean; /** - * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. + * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. * * * @@ -21063,13 +21063,13 @@ interface IgCombo { filteringType?: string; /** - * Gets/Sets URL key name that specifies how the remote filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. + * Gets/Sets URL key name that specifies how the remote filtering expressions will be encoded for remote requests, e.g. &filter('col') = startsWith. Default is OData. * */ filterExprUrlKey?: string; /** - * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". + * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". * * * @@ -21088,7 +21088,7 @@ interface IgCombo { filteringCondition?: string; /** - * Gets/Sets filtering logic. + * Gets/Sets filtering logic. * * * Valid values: @@ -21098,13 +21098,13 @@ interface IgCombo { filteringLogic?: string; /** - * Gets/Sets text of list item for condition when [filteringType](ui.igcombo#options:filteringType) option is enabled and no match was found. That is an override for the $.ig.Combo.locale.noMatchFoundText. + * Gets/Sets text of list item for condition when [filteringType](ui.igcombo#options:filteringType) option is enabled and no match was found. That is an override for the $.ig.Combo.locale.noMatchFoundText. * */ noMatchFoundText?: string; /** - * Gets/Sets container of variables which define load on demand functionality. + * Gets/Sets container of variables which define load on demand functionality. * Notes: * That option has effect only when data is loaded remotely using [dataSourceUrl](ui.igcombo#options:dataSourceUrl). * Selection is supported only for already loaded items. @@ -21113,7 +21113,7 @@ interface IgCombo { loadOnDemandSettings?: IgComboLoadOnDemandSettings; /** - * Gets/Sets how many items should be shown at once. + * Gets/Sets how many items should be shown at once. * Notes: * This option is used for [virtualization](ui.igcombo#options:virtualization) in order to render initial list items. * @@ -21121,13 +21121,13 @@ interface IgCombo { visibleItemsCount?: number; /** - * Gets/Sets value that is displayed when input field is empty. That is an override for the $.ig.Combo.locale.placeHolder. + * Gets/Sets value that is displayed when input field is empty. That is an override for the $.ig.Combo.locale.placeHolder. * */ placeHolder?: string; /** - * Sets gets functionality mode. + * Sets gets functionality mode. * * * Valid values: @@ -21139,33 +21139,33 @@ interface IgCombo { mode?: string; /** - * Gets/Sets ability to use virtual rendering for drop-down list. Enable to boost performance when combo has lots of records. + * Gets/Sets ability to use virtual rendering for drop-down list. Enable to boost performance when combo has lots of records. * If that option is enabled, then only visible items are created and the top edge of the first visible item in list is aligned to the top edge of list. * */ virtualization?: boolean; /** - * Gets/Sets object specifying multi selection feature options. Note showCheckboxes and itemSeparator has effect only if multi selection is enabled. + * Gets/Sets object specifying multi selection feature options. Note showCheckboxes and itemSeparator has effect only if multi selection is enabled. * */ multiSelection?: IgComboMultiSelection; /** - * Gets/Sets object specifying grouping feature options. The option has key and dir properties. + * Gets/Sets object specifying grouping feature options. The option has key and dir properties. * */ grouping?: IgComboGrouping; /** - * Gets/Sets object which contains options supported by [igValidator](ui.igvalidator). + * Gets/Sets object which contains options supported by [igValidator](ui.igvalidator). * Notes: in order for validator to work, application should ensure that [igValidator](ui.igvalidator) is loaded (ig.ui.validator.js/css files). * */ validatorOptions?: any; /** - * Gets/Sets condition used for highlighting of matching parts in items of drop-down list. + * Gets/Sets condition used for highlighting of matching parts in items of drop-down list. * * * Valid values: @@ -21178,26 +21178,26 @@ interface IgCombo { highlightMatchesMode?: string; /** - * If set to true, filtering and auto selection will be case-sensitive. + * If set to true, filtering and auto selection will be case-sensitive. * */ caseSensitive?: boolean; /** - * Gets/Sets whether the first matching item should be auto selected when typing in input. When [multiSelection](ui.igcombo#options:multiSelection) is enabled this option will instead put the active item on the matching element. + * Gets/Sets whether the first matching item should be auto selected when typing in input. When [multiSelection](ui.igcombo#options:multiSelection) is enabled this option will instead put the active item on the matching element. * */ autoSelectFirstMatch?: boolean; /** - * Gets/Sets ability to autocomplete field from first matching item in list. + * Gets/Sets ability to autocomplete field from first matching item in list. * Note: When autoComplete option is enabled, then "startsWith" is used for [filteringCondition](ui.igcombo#options:filteringCondition). * */ autoComplete?: boolean; /** - * If set to true: + * If set to true: * 1. Allows custom value input only with single selection. * 2. Custom values will be auto completed to the closest value if [autoComplete](ui.igcombo#options:autoComplete) is enabled. * @@ -21205,56 +21205,56 @@ interface IgCombo { allowCustomValue?: boolean; /** - * Gets/Sets ability to close drop-down list when control loses focus. + * Gets/Sets ability to close drop-down list when control loses focus. * */ closeDropDownOnBlur?: boolean; /** - * Specifies the delay duration before processing the changes in the input. Useful to boost performance by lowering the count of selection, filtering, auto complete and highlighting operations executed on each input change. + * Specifies the delay duration before processing the changes in the input. Useful to boost performance by lowering the count of selection, filtering, auto complete and highlighting operations executed on each input change. * */ delayInputChangeProcessing?: number; /** - * Gets/Sets tabIndex for the field of the combo. + * Gets/Sets tabIndex for the field of the combo. * */ tabIndex?: number; /** - * Gets/Sets ability to show the drop-down list when the combo is in focus. This option has effect only if the combo is in editable [mode](ui.igcombo#options:mode). + * Gets/Sets ability to show the drop-down list when the combo is in focus. This option has effect only if the combo is in editable [mode](ui.igcombo#options:mode). * */ dropDownOnFocus?: boolean; /** - * Gets sets ability to close drop-down list when single item in the list is selected with mouse click or enter press. The default value when [multiSelection](ui.igcombo#options:multiSelection) is enabled will be false. This option will not close the drop down when [multiSelection](ui.igcombo#options:multiSelection) is enabled and additive selection is performed. + * Gets sets ability to close drop-down list when single item in the list is selected with mouse click or enter press. The default value when [multiSelection](ui.igcombo#options:multiSelection) is enabled will be false. This option will not close the drop down when [multiSelection](ui.igcombo#options:multiSelection) is enabled and additive selection is performed. * */ closeDropDownOnSelect?: boolean; /** - * Gets/Sets ability to select items by space button press. + * Gets/Sets ability to select items by space button press. * */ selectItemBySpaceKey?: boolean; /** - * Gets/Sets list of items to be selected when the combo is initialized. It should contain array of objects with index or value property, then on initialization the matching items will be selected. If initialSelectedItems are not set, the combo is with single selection and it is in a dropdown, readonly or readonlylist [mode](ui.igcombo#options:mode), the first item will be automatically selected. + * Gets/Sets list of items to be selected when the combo is initialized. It should contain array of objects with index or value property, then on initialization the matching items will be selected. If initialSelectedItems are not set, the combo is with single selection and it is in a dropdown, readonly or readonlylist [mode](ui.igcombo#options:mode), the first item will be automatically selected. * Note: Only items loaded on initialization can be selected. When using [load on demand](ui.igCombo#options:loadOnDemandSettings), selecting an item which is not loaded yet will fail. * */ initialSelectedItems?: IgComboInitialSelectedItem[]; /** - * Gets/Sets ability to prevent submitting form on enter key press. + * Gets/Sets ability to prevent submitting form on enter key press. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the format string that is used to format the text display values in the combo. + * Gets/Sets the format string that is used to format the text display values in the combo. * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting @@ -21267,33 +21267,33 @@ interface IgCombo { format?: string; /** - * Gets/Sets whether the onscreen keyboard should be shown when the dropdown button is clicked (touch devices only). + * Gets/Sets whether the onscreen keyboard should be shown when the dropdown button is clicked (touch devices only). * Note: The keyboard will still show when the combo input is focused in editable mode. * */ suppressKeyboard?: boolean; /** - * Specifies whether the clear button should be rendered. + * Specifies whether the clear button should be rendered. * When the [mode](ui.igcombo#options:mode) is single selection, readonly or readonlylist this option will default to false. It can still be enabled when it is specifically set to true. * */ enableClearButton?: boolean; /** - * Gets/Sets title for html element which represent the drop-down button. This is an override for the $.ig.Combo.locale.dropDownButtonTitle. + * Gets/Sets title for html element which represent the drop-down button. This is an override for the $.ig.Combo.locale.dropDownButtonTitle. * */ dropDownButtonTitle?: string; /** - * Gets/Sets title for html element which represent clear button (this is an override for the $.ig.Combo.locale.clearButtonTitle). + * Gets/Sets title for html element which represent clear button (this is an override for the $.ig.Combo.locale.clearButtonTitle). * */ clearButtonTitle?: string; /** - * Gets/Sets drop-down list orientation when open button is clicked. + * Gets/Sets drop-down list orientation when open button is clicked. * * * Valid values: @@ -21304,7 +21304,7 @@ interface IgCombo { dropDownOrientation?: string; /** - * Event which is raised after rendering of the combo completes. + * Event which is raised after rendering of the combo completes. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. @@ -21313,7 +21313,7 @@ interface IgCombo { rendered?: RenderedEvent; /** - * Event which is raised before data binding is performed. + * Event which is raised before data binding is performed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. @@ -21322,7 +21322,7 @@ interface IgCombo { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding is complete. + * Event which is raised after data binding is complete. * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. @@ -21333,7 +21333,7 @@ interface IgCombo { dataBound?: DataBoundEvent; /** - * Event which is raised before data filtering. + * Event which is raised before data filtering. * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21343,7 +21343,7 @@ interface IgCombo { filtering?: FilteringEvent; /** - * Event which is raised after filtering. + * Event which is raised after filtering. * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. @@ -21353,7 +21353,7 @@ interface IgCombo { filtered?: FilteredEvent; /** - * Event which is raised before rendering of the combo items is performed. + * Event which is raised before rendering of the combo items is performed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. @@ -21362,7 +21362,7 @@ interface IgCombo { itemsRendering?: ItemsRenderingEvent; /** - * Event which is raised after rendering of the combo items completes. + * Event which is raised after rendering of the combo items completes. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. @@ -21371,7 +21371,7 @@ interface IgCombo { itemsRendered?: ItemsRenderedEvent; /** - * Event which is raised before drop-down list is opened. + * Event which is raised before drop-down list is opened. * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. @@ -21381,7 +21381,7 @@ interface IgCombo { dropDownOpening?: DropDownOpeningEvent; /** - * Event which is raised after drop-down list was opened. + * Event which is raised after drop-down list was opened. * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21390,7 +21390,7 @@ interface IgCombo { dropDownOpened?: DropDownOpenedEvent; /** - * Event which is raised before drop-down list is closed. + * Event which is raised before drop-down list is closed. * * Return false in order to cancel hide action. * Function takes arguments evt and ui. @@ -21400,7 +21400,7 @@ interface IgCombo { dropDownClosing?: DropDownClosingEvent; /** - * Event which is raised after drop-down list was closed. + * Event which is raised after drop-down list was closed. * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -21410,7 +21410,7 @@ interface IgCombo { dropDownClosed?: DropDownClosedEvent; /** - * Event which is raised before selection change. + * Event which is raised before selection change. * * Return false in order to cancel change. * Function takes arguments evt and ui. @@ -21421,7 +21421,7 @@ interface IgCombo { selectionChanging?: SelectionChangingEvent; /** - * Event which is raised after selection change. + * Event which is raised after selection change. * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21431,76 +21431,76 @@ interface IgCombo { selectionChanged?: SelectionChangedEvent; /** - * Option for igCombo + * Option for igCombo */ [optionName: string]: any; } interface IgComboMethods { /** - * Performs databinding on the combo box. The [databinding](ui.igcombo#events:dataBinding) and [dataBound](ui.igcombo#events:dataBound) events are always raised. + * Performs databinding on the combo box. The [databinding](ui.igcombo#events:dataBinding) and [dataBound](ui.igcombo#events:dataBound) events are always raised. */ dataBind(): Object; /** - * Forces an update of the igCombo value according to the current text in the igCombo input. + * Forces an update of the igCombo value according to the current text in the igCombo input. * - * The refresh is primarily intended to be used with [allowCustomValue](ui.igcombo#options:allowCustomValue) set to true. - * The refresh will take the current text and, if no selection is applied, will set it as igCombo value provided that [allowCustomValue](ui.igcombo#options:allowCustomValue) true. + * The refresh is primarily intended to be used with [allowCustomValue](ui.igcombo#options:allowCustomValue) set to true. + * The refresh will take the current text and, if no selection is applied, will set it as igCombo value provided that [allowCustomValue](ui.igcombo#options:allowCustomValue) true. */ refreshValue(): Object; /** - * Gets the associated data of an item by value matching it's [valueKey](ui.igcombo#options:valueKey) property. + * Gets the associated data of an item by value matching it's [valueKey](ui.igcombo#options:valueKey) property. * * @param value Value matching the valueKey property of item to be tested if it is selected */ dataForValue(value: Object): Object; /** - * Gets the associated data of li element in the combo. + * Gets the associated data of li element in the combo. * * @param $element jQuery element of item in the drop down list */ dataForElement($element: Object): Object; /** - * Gets object/s containing data and list item in the combo by element/s. + * Gets object/s containing data and list item in the combo by element/s. * * @param $element jQuery object with drop down list item element or elements */ itemsFromElement($element: Object): Object; /** - * Gets object/s containing data and list item in the combo by value/s. + * Gets object/s containing data and list item in the combo by value/s. * * @param value Value of item in the drop down list or array with values. */ itemsFromValue(value: Object): Object; /** - * Gets object/s containing data and list item in the combo by index/es. + * Gets object/s containing data and list item in the combo by index/es. * * @param index Index or array of indexes of items in the drop down list */ itemsFromIndex(index: number): Object; /** - * Gets array with data and objects representing li elements in combo box. + * Gets array with data and objects representing li elements in combo box. */ items(): any[]; /** - * Gets array with objects representing the filtered li elements in combo box. + * Gets array with objects representing the filtered li elements in combo box. */ filteredItems(): any[]; /** - * Gets array with objects representing selected li elements in combo box. + * Gets array with objects representing selected li elements in combo box. */ selectedItems(): any[]; /** - * Triggers filtering. + * Triggers filtering. * * @param texts Filter by string, or array of strings. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [filtering](ui.igcombo#events:filtering) and [filtered](ui.igcombo#events:filtered) events. @@ -21508,14 +21508,14 @@ interface IgComboMethods { filter(texts?: Object, event?: Object): Object; /** - * Clears filtering. + * Clears filtering. * * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [filtering](ui.igcombo#events:filtering) and [filtered](ui.igcombo#events:filtered) events. */ clearFiltering(event?: Object): Object; /** - * Opens the drop-down. + * Opens the drop-down. * * @param callback Specifies callback function to be executed when open animation is completed. * @param focusCombo Set to false to not focus combo"s text input after the drop down is opened. By default the combo's input is focused. @@ -21524,7 +21524,7 @@ interface IgComboMethods { openDropDown(callback?: Function, focusCombo?: boolean, event?: Object): Object; /** - * Closes the drop down. + * Closes the drop down. * * @param callback Specifies callback function to be executed when close animation is completed. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [dropDownClosing](ui.igcombo#events:dropDownClosing) and [dropDownClosed](ui.igcombo#events:dropDownClosed) events. @@ -21532,146 +21532,146 @@ interface IgComboMethods { closeDropDown(callback?: Function, event?: Object): Object; /** - * Clears the input text, resets highlighting, filtering and selection. + * Clears the input text, resets highlighting, filtering and selection. * * @param options Object with set of options controlling the behavior of this api method. - focusCombo (boolean): Set to true to focus combo after clearing the input. + * focusCombo (boolean): Set to true to focus combo after clearing the input. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ clearInput(options?: Object, event?: Object): Object; /** - * Verifies whether the specified li is selected. + * Verifies whether the specified li is selected. * * @param $item jQuery object with item to verify whether it is selected. */ isSelected($item: Object): boolean; /** - * Verifies whether a specified value is selected. + * Verifies whether a specified value is selected. * * @param value Value matching the [valueKey](ui.igcombo#options:valueKey) property of item to be tested if it is selected */ isValueSelected(value: Object): boolean; /** - * Verifies whether the li representing the data source's record at the specified index is selected. + * Verifies whether the li representing the data source's record at the specified index is selected. * * @param index Index of data source record */ isIndexSelected(index: Object): boolean; /** - * Selects list item/items from the drop-down list by specified value or array of values. When called witout params will return the value of the selected item or if [multiSelection](ui.igcombo#options:multiSelection) is enabled array of selected values. + * Selects list item/items from the drop-down list by specified value or array of values. When called witout params will return the value of the selected item or if [multiSelection](ui.igcombo#options:multiSelection) is enabled array of selected values. * * @param value Value or array of values matching the valueKey property of item/items to be selected * @param options Object with set of options controlling the behavior of this api method. - closeDropDown (boolean): Set to true to close the drop down list after the selection. - focusCombo (boolean): Set to true to focus combo after the selection. - additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ value(value?: Object, options?: Object, event?: Object): Object; /** - * Selects a list item from the drop-down list. + * Selects a list item from the drop-down list. * * @param $items jQuery object with item or items to be selected. * @param options Object with set of options controlling the behavior of this api method. - closeDropDown (boolean): Set to true to close the drop down list after the selection. - focusCombo (boolean): Set to true to focus combo after the selection. - additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ select($items: Object, options?: Object, event?: Object): Object; /** - * Gets/Sets selected item/s from the drop-down list by specified index. + * Gets/Sets selected item/s from the drop-down list by specified index. * * @param index Index or array of indexes of items to be selected * @param options Object with set of options controlling the behavior of this api method. - closeDropDown (boolean): Set to true to close the drop down list after the selection. - focusCombo (boolean): Set to true to focus combo after the selection. - additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. - keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * additive (boolean): Set to true to select the item without losing other selection. Works only when multi selection is enabled. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ index(index?: Object, options?: Object, event?: Object): Object; /** - * Selects all items from the drop-down list. + * Selects all items from the drop-down list. * * @param options Object with set of options controlling the behavior of this api method. - closeDropDown (boolean): Set to true to close the drop down list after the selection. - focusCombo (boolean): Set to true to focus combo after the selection. - keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. - keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. - keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. - keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. - keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. + * closeDropDown (boolean): Set to true to close the drop down list after the selection. + * focusCombo (boolean): Set to true to focus combo after the selection. + * keepFiltering (boolean): Set to true to keep filtering after the selection. By default the filtering is cleared. + * keepInputText (boolean): Set to true to keep input text unchanged after the selection. By default input text is updated. + * keepHighlighting (boolean): Set to true to keep highlighting unchanged after the selection. By default highlighting is removed. + * keepNavItem (boolean): Set to true to keep current navigation item unchanged after the selection. By default the navigation item is changed to the new selected item. + * keepScrollPosition (boolean): Set to true to keep current scroll position. By default the scroll position will change so that the last selected item is visible. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ selectAll(options?: Object, event?: Object): Object; /** - * Deselects a list item from the drop down list by value. + * Deselects a list item from the drop down list by value. * * @param value Value or array of values matching the [valueKey](ui.igcombo#options:valueKey) property of item/items to be deselected * @param options Object with set of options controlling the behavior of this api method. - focusCombo (boolean): Set to true to focus combo after the deselection. - keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectByValue(value: Object, options?: Object, event?: Object): Object; /** - * Deselects a list item from the drop down list. + * Deselects a list item from the drop down list. * * @param $items jQuery object with item or items to be deselected * @param options Object with set of options controlling the behavior of this api method. - focusCombo (boolean): Set to true to focus combo after the deselection. - keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselect($items: Object, options?: Object, event?: Object): Object; /** - * Deselects a list item from the drop down list by index. + * Deselects a list item from the drop down list by index. * * @param index Index or array of indexes of items to be selected * @param options Object with set of options controlling the behavior of this api method. - focusCombo (boolean): Set to true to focus combo after the deselection. - keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectByIndex(index: Object, options?: Object, event?: Object): Object; /** - * Deselects all selected items from the drop down list. + * Deselects all selected items from the drop down list. * * @param options Object with set of options controlling the behavior of this api method. - focusCombo (boolean): Set to true to focus combo after the deselection. - keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. + * focusCombo (boolean): Set to true to focus combo after the deselection. + * keepInputText (boolean): Set to true to keep input text unchanged after the deselection. By default input text is updated. * @param event Indicates the browser event which triggered this action (not API). Calling the method with this param set to "true" will trigger [selectionChanging](ui.igcombo#events:selectionChanging) and [selectionChanged](ui.igcombo#events:selectionChanged) events. */ deselectAll(options?: Object, event?: Object): Object; /** - * Gets/Sets index of active item in list. + * Gets/Sets index of active item in list. * * @param index New active index for list. In order to clear active item, use -1. * @return number|object Returns index of active item in list or -1, if parameter is undefined. Otherwise, it returns reference to this igCombo. @@ -21679,7 +21679,7 @@ interface IgComboMethods { activeIndex(index?: number): number|Object; /** - * Gets/Sets text in text input field. + * Gets/Sets text in text input field. * * @param text New text value for combo's input field. * @return string|object If parameter is undefined, then current text in field is returned. Otherwise, it returns reference to this igCombo. @@ -21687,7 +21687,7 @@ interface IgComboMethods { text(text?: string): string|Object; /** - * Gets/Sets scrollTop attribute of html element, which scrolls drop-down list of items. + * Gets/Sets scrollTop attribute of html element, which scrolls drop-down list of items. * * @param value New value for scroll top in list. Note: if list is closed and new value is provided, then openDropDown() is called automatically. * @return number|object If parameter is undefined, then scrollTop is returned. Otherwise, it returns reference to this igCombo. @@ -21695,59 +21695,59 @@ interface IgComboMethods { listScrollTop(value?: number): number|Object; /** - * Gets jQuery objects representing all rendered list items in the combo drop down list. + * Gets jQuery objects representing all rendered list items in the combo drop down list. */ listItems(): Object; /** - * Gets jQuery object of the outer element of the combo. + * Gets jQuery object of the outer element of the combo. */ comboWrapper(): Object; /** - * Gets jQuery object of the drop down associated with this combo widget + * Gets jQuery object of the drop down associated with this combo widget */ dropDown(): Object; /** - * Gets jQuery object of the container that holds the list with items. + * Gets jQuery object of the container that holds the list with items. */ list(): Object; /** - * Gets jQuery object of the text input associated with this combo widget. + * Gets jQuery object of the text input associated with this combo widget. */ textInput(): Object; /** - * Gets jQuery object of the value input associated with this combo widget. + * Gets jQuery object of the value input associated with this combo widget. */ valueInput(): Object; /** - * Gets reference to [igValidator](ui.igvalidator) used by igCombo. + * Gets reference to [igValidator](ui.igvalidator) used by igCombo. * * @param destroy Request to destroy validator. */ validator(destroy?: boolean): Object; /** - * Trigger validation. + * Trigger validation. */ validate(): boolean; /** - * Returns boolean representing whether the combo drop down list is opened. + * Returns boolean representing whether the combo drop down list is opened. */ dropDownOpened(): boolean; /** - * Repositions drop down under combo input. Has effect only when the drop down is attached to body. + * Repositions drop down under combo input. Has effect only when the drop down is attached to body. */ positionDropDown(): Object; /** - * Destroys the igCombo widget. + * Destroys the igCombo widget. */ destroy(): Object; } @@ -22882,27 +22882,27 @@ interface StateChangingEvent { interface StateChangingEventUIParam { /** - * Used to obtain a reference to the igDialog. + * Used to obtain a reference to the igDialog. */ owner?: any; /** - * Used ton to obtain the name of the button, which triggered the event. Note: if the state was modified from the code, then "button" is undefined. + * Used ton to obtain the name of the button, which triggered the event. Note: if the state was modified from the code, then "button" is undefined. */ button?: any; /** - * Used to obtain the old state of the dialog, which can be one of the following: "opened", "minimized", "maximized", "closed". + * Used to obtain the old state of the dialog, which can be one of the following: "opened", "minimized", "maximized", "closed". */ oldState?: any; /** - * Used to obtain the boolean value of the old pin state of the dialog. + * Used to obtain the boolean value of the old pin state of the dialog. */ oldPinned?: any; /** - * Used to obtain the name of the action. That can be one of the following: + * Used to obtain the name of the action. That can be one of the following: */ action?: any; } @@ -22913,27 +22913,27 @@ interface StateChangedEvent { interface StateChangedEventUIParam { /** - * Used to obtain a reference to the igDialog. + * Used to obtain a reference to the igDialog. */ owner?: any; /** - * Used ton to obtain the name of the button, which triggered the event. Note: if the state was modified from the code, then "button" is undefined. + * Used ton to obtain the name of the button, which triggered the event. Note: if the state was modified from the code, then "button" is undefined. */ button?: any; /** - * Used to obtain the old state of the dialog, which can be one of the following: "opened", "minimized", "maximized", "closed". + * Used to obtain the old state of the dialog, which can be one of the following: "opened", "minimized", "maximized", "closed". */ oldState?: any; /** - * Used to obtain the boolean value of the old pin state of the dialog. + * Used to obtain the boolean value of the old pin state of the dialog. */ oldPinned?: any; /** - * Used to obtain the name of the action. That can be one of the following: + * Used to obtain the name of the action. That can be one of the following: */ action?: any; } @@ -22944,12 +22944,12 @@ interface AnimationEndedEvent { interface AnimationEndedEventUIParam { /** - * Used to obtain a reference to the igDialog. + * Used to obtain a reference to the igDialog. */ owner?: any; /** - * Used to obtain the name of the action, which triggered the animation. + * Used to obtain the name of the action, which triggered the animation. */ action?: any; } @@ -22960,7 +22960,7 @@ interface FocusEvent { interface FocusEventUIParam { /** - * Used to obtain a reference to the igDialog. + * Used to obtain a reference to the igDialog. */ owner?: any; } @@ -22971,14 +22971,14 @@ interface BlurEvent { interface BlurEventUIParam { /** - * Used to obtain a reference to the igDialog. + * Used to obtain a reference to the igDialog. */ owner?: any; } interface IgDialog { /** - * Gets the jquery DIV object which is used as the main container for the dialog. + * Gets the jquery DIV object which is used as the main container for the dialog. * Notes: * 1. That object is optional and it should not contain any children. * 2. It should not have parent. @@ -22989,7 +22989,7 @@ interface IgDialog { mainElement?: Element; /** - * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. + * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. * * * @@ -23002,7 +23002,7 @@ interface IgDialog { state?: string; /** - * Gets/Sets whether the dialog is pinned. + * Gets/Sets whether the dialog is pinned. * When the dialog is pinned, then the html element of the dialog is moved to the original container where the target element was located and position:absolute is removed. * The pinned dialog does not support modal state, maximized state and it can not be moved. * Notes: @@ -23013,79 +23013,79 @@ interface IgDialog { pinned?: boolean; /** - * Gets/Sets whether the dialog should close when Esc key is pressed. + * Gets/Sets whether the dialog should close when Esc key is pressed. * */ closeOnEscape?: boolean; /** - * Gets/Sets whether the close button in the dialog header should be visible. + * Gets/Sets whether the close button in the dialog header should be visible. * */ showCloseButton?: boolean; /** - * Gets/Sets whether the maximize button in the dialog header should be visible. + * Gets/Sets whether the maximize button in the dialog header should be visible. * */ showMaximizeButton?: boolean; /** - * Gets/Sets whether the minimize button in the dialog header should be visible. + * Gets/Sets whether the minimize button in the dialog header should be visible. * */ showMinimizeButton?: boolean; /** - * Gets/Sets whether the pin button in the dialog header should be visible. + * Gets/Sets whether the pin button in the dialog header should be visible. * */ showPinButton?: boolean; /** - * Gets/Sets whether the dialog will be pinned on minimize. + * Gets/Sets whether the dialog will be pinned on minimize. * */ pinOnMinimized?: boolean; /** - * Gets the name of the css class which is applied to the SPAN element located on the left side of the header. + * Gets the name of the css class which is applied to the SPAN element located on the left side of the header. * */ imageClass?: string; /** - * Gets/Sets the text which appears in the header of the dialog. + * Gets/Sets the text which appears in the header of the dialog. * */ headerText?: string; /** - * Gets/Sets whether the dialog header should be visible. + * Gets/Sets whether the dialog header should be visible. * */ showHeader?: boolean; /** - * Gets/Sets whether the dialog footer should be visible. + * Gets/Sets whether the dialog footer should be visible. * */ showFooter?: boolean; /** - * Gets/Sets the text which appears in the footer of the dialog. + * Gets/Sets the text which appears in the footer of the dialog. * */ footerText?: string; /** - * Gets the name of the css class which is applied to the main DIV element of the dialog. + * Gets the name of the css class which is applied to the main DIV element of the dialog. * */ dialogClass?: string; /** - * Gets/Sets the container html element for the dialog. + * Gets/Sets the container html element for the dialog. * That can be reference to html element, jquery selector or jquery object. * By default the parent form of the original target element is used. If a form is not found, then the body is used. * Note: If the "position" of the container is not set or it is "static", then the position is set to "relative". @@ -23094,7 +23094,7 @@ interface IgDialog { container?: any; /** - * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". + * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * * @@ -23102,7 +23102,7 @@ interface IgDialog { height?: number|string; /** - * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". + * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. * * @@ -23110,74 +23110,74 @@ interface IgDialog { width?: number|string; /** - * Gets/Sets the minimal height of the dialog in normal state. + * Gets/Sets the minimal height of the dialog in normal state. * */ minHeight?: number; /** - * Gets/Sets the minimal width of the dialog in normal state. + * Gets/Sets the minimal width of the dialog in normal state. * */ minWidth?: number; /** - * Gets/Sets the maximal height of the dialog in normal state. Note: that option has effect only while resizing the dialog by the end user. + * Gets/Sets the maximal height of the dialog in normal state. Note: that option has effect only while resizing the dialog by the end user. * */ maxHeight?: number; /** - * Gets/Sets the maximal width of the dialog in normal state. Note: that option has effect only while resizing the dialog by the end user. + * Gets/Sets the maximal width of the dialog in normal state. Note: that option has effect only while resizing the dialog by the end user. * */ maxWidth?: number; /** - * Gets/Sets whether the dialog can be dragged by the user. + * Gets/Sets whether the dialog can be dragged by the user. * */ draggable?: boolean; /** - * Gets/Sets the initial position of the dialog. That should be an object, which contains "top" and "left" members or an object + * Gets/Sets the initial position of the dialog. That should be an object, which contains "top" and "left" members or an object * supported by jquery.position(param) method. Examples: { left: 100, top: 200 }, { my: "left top", at: "left top", offset: "100 200" } * */ position?: any; /** - * Gets/Sets whether the dialog can be resized by the user. + * Gets/Sets whether the dialog can be resized by the user. * */ resizable?: boolean; /** - * Gets/Sets the value for the tabIndex attribute applied to the main html element of the dialog. + * Gets/Sets the value for the tabIndex attribute applied to the main html element of the dialog. * */ tabIndex?: number; /** - * Gets/Sets the animation applied to the dialog when it is opened. That can be any object supported by the jquery show(param) method. + * Gets/Sets the animation applied to the dialog when it is opened. That can be any object supported by the jquery show(param) method. * */ openAnimation?: any; /** - * Gets/Sets the animation applied to the dialog when it is closed. That can be any object supported by the jquery hide(param) method. + * Gets/Sets the animation applied to the dialog when it is closed. That can be any object supported by the jquery hide(param) method. * */ closeAnimation?: any; /** - * Gets/Sets the value of zIndex applied to the main html element of the dialog. If value is not set, then 1000 is used. + * Gets/Sets the value of zIndex applied to the main html element of the dialog. If value is not set, then 1000 is used. * */ zIndex?: number; /** - * Gets/Sets the modal state of the dialog. + * Gets/Sets the modal state of the dialog. * If there are more than 1 modal igDialog, then the last opened dialog wins and becomes on the top. * Note: the modal functionality is not supported when the dialog is minimized or pinned, because that will trigger misbehavior. * @@ -23185,7 +23185,7 @@ interface IgDialog { modal?: boolean; /** - * Gets/Sets the ability to process focus and blur events of the child elements located in the dialog in order to maintain the focused state. + * Gets/Sets the ability to process focus and blur events of the child elements located in the dialog in order to maintain the focused state. * Notes: * If that option is enabled, then focus and blur event handlers are added to all the child elements of the dialog. * If the dialog is modal or it can be maximized, then it is not recommended to disable that option. @@ -23195,55 +23195,55 @@ interface IgDialog { trackFocus?: boolean; /** - * Gets/Sets the title/tooltip for the close button in the dialog. That is an override for $.ig.Dialog.locale.closeButtonTitle. + * Gets/Sets the title/tooltip for the close button in the dialog. That is an override for $.ig.Dialog.locale.closeButtonTitle. * */ closeButtonTitle?: string; /** - * Gets/Sets the title/tooltip for the minimize button in the dialog. That is an override for $.ig.Dialog.locale.minimizeButtonTitle. + * Gets/Sets the title/tooltip for the minimize button in the dialog. That is an override for $.ig.Dialog.locale.minimizeButtonTitle. * */ minimizeButtonTitle?: string; /** - * Gets/Sets the title/tooltip for the maximize button in the dialog. That is an override for $.ig.Dialog.locale.maximizeButtonTitle. + * Gets/Sets the title/tooltip for the maximize button in the dialog. That is an override for $.ig.Dialog.locale.maximizeButtonTitle. * */ maximizeButtonTitle?: string; /** - * Gets/Sets the title/tooltip for the pin button in the dialog. That is an override for $.ig.Dialog.locale.pinButtonTitle. + * Gets/Sets the title/tooltip for the pin button in the dialog. That is an override for $.ig.Dialog.locale.pinButtonTitle. * */ pinButtonTitle?: string; /** - * Gets/Sets the title/tooltip for the unpin button in the dialog. That is an override for $.ig.Dialog.locale.unpinButtonTitle. + * Gets/Sets the title/tooltip for the unpin button in the dialog. That is an override for $.ig.Dialog.locale.unpinButtonTitle. * */ unpinButtonTitle?: string; /** - * Gets/Sets the title/tooltip for the restore button in the dialog. That is an override for $.ig.Dialog.locale.restoreButtonTitle. + * Gets/Sets the title/tooltip for the restore button in the dialog. That is an override for $.ig.Dialog.locale.restoreButtonTitle. * */ restoreButtonTitle?: string; /** - * Gets/Sets the temporary value for src, which is used while changing the parent of the base element if it is an instance of IFRAME. That allows getting around possible JavaScript exceptions under IE. + * Gets/Sets the temporary value for src, which is used while changing the parent of the base element if it is an instance of IFRAME. That allows getting around possible JavaScript exceptions under IE. * */ temporaryUrl?: string; /** - * Gets/Sets the ability to adjust the state of the header depending on focused and not-focused states. Note: the "trackFocus" option should be enabled. + * Gets/Sets the ability to adjust the state of the header depending on focused and not-focused states. Note: the "trackFocus" option should be enabled. * */ enableHeaderFocus?: boolean; /** - * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. + * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. * @@ -23252,7 +23252,7 @@ interface IgDialog { enableDblclick?: any; /** - * Event which is raised before the state of dialog was changed. + * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. * * The function takes arguments "evt" and "ui". @@ -23273,7 +23273,7 @@ interface IgDialog { stateChanging?: StateChangingEvent; /** - * Event which is raised after the state of the dialog was changed. + * Event which is raised after the state of the dialog was changed. * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. @@ -23293,7 +23293,7 @@ interface IgDialog { stateChanged?: StateChangedEvent; /** - * Event which is raised after the end of the animation when the dialod was closed or opened. + * Event which is raised after the end of the animation when the dialod was closed or opened. * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. @@ -23304,7 +23304,7 @@ interface IgDialog { animationEnded?: AnimationEndedEvent; /** - * Event which is raised when the dialog or its content gets focus. + * Event which is raised when the dialog or its content gets focus. * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. @@ -23313,7 +23313,7 @@ interface IgDialog { focus?: FocusEvent; /** - * Event which is raised when the dialog or its content loses focus. + * Event which is raised when the dialog or its content loses focus. * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. @@ -23322,100 +23322,100 @@ interface IgDialog { blur?: BlurEvent; /** - * Option for igDialog + * Option for igDialog */ [optionName: string]: any; } interface IgDialogMethods { /** - * Destroys the igDialog and moves the target element to its original parent. + * Destroys the igDialog and moves the target element to its original parent. */ destroy(): Object; /** - * Gets/Sets the state of the editor. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Gets/Sets the state of the editor. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. * * @param state New state. */ state(state?: string): string; /** - * Gets reference to the dynamically created DIV element which represents the dialog. + * Gets reference to the dynamically created DIV element which represents the dialog. */ mainElement(): Element; /** - * Closes the dialog if it is opened. - * Notes: - * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. - * 2. That method does not change minimized or maximized state of the dialog. - * It means that method "open" will open the dialog and keep previous minimized or maximized state. + * Closes the dialog if it is opened. + * Notes: + * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * 2. That method does not change minimized or maximized state of the dialog. + * It means that method "open" will open the dialog and keep previous minimized or maximized state. * * @param e Browser event: internal use only. */ close(e?: Object): Object; /** - * Opens the dialog if it is closed. Notes: - * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. - * 2. That method does not change minimized or maximized state of the dialog. It means that if the dialog was in minimized or maximized stated when closed by "close" method, then the dialog will open in minimized or maximized state respectively. + * Opens the dialog if it is closed. Notes: + * 1. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * 2. That method does not change minimized or maximized state of the dialog. It means that if the dialog was in minimized or maximized stated when closed by "close" method, then the dialog will open in minimized or maximized state respectively. */ open(): Object; /** - * Minimizes the dialog if it is not minimized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Minimizes the dialog if it is not minimized. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ minimize(): Object; /** - * Maximizes the dialog if it is not maximized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Maximizes the dialog if it is not maximized. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ maximize(): Object; /** - * Sets the normal state for the dialog if it was maximized or minimized. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Sets the normal state for the dialog if it was maximized or minimized. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ restore(): Object; /** - * Pins the dialog if it is not pinned. - * When the dialog is pinned, then the html element of the dialog is moved to the original container where the target element was located and position:absolute is removed. - * The pinned dialog does not support modal state, maximized state and it can not be moved. - * Notes: - * 1. If the parent element of the original target-element is invisible, then the pinned dialog becomes invisible as well. - * 2. If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Pins the dialog if it is not pinned. + * When the dialog is pinned, then the html element of the dialog is moved to the original container where the target element was located and position:absolute is removed. + * The pinned dialog does not support modal state, maximized state and it can not be moved. + * Notes: + * 1. If the parent element of the original target-element is invisible, then the pinned dialog becomes invisible as well. + * 2. If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ pin(): Object; /** - * Unpins the dialog if it is pinned. - * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. + * Unpins the dialog if it is pinned. + * Note: If the state of the dialog changes, then stateChanging and stateChanged events are raised. */ unpin(): Object; /** - * Gets a reference to the top modal dialog. + * Gets a reference to the top modal dialog. */ getTopModal(): Object; /** - * Checks if the dialog is modal and if it is currently active. + * Checks if the dialog is modal and if it is currently active. */ isTopModal(): boolean; /** - * Moves a not modal dialog to the top. + * Moves a not modal dialog to the top. * * @param e Original event of browser. */ moveToTop(e?: Object): Object; /** - * Retrieves the igDialog content container or sets its content to be the new content provided. + * Retrieves the igDialog content container or sets its content to be the new content provided. * * @param newContent The new html content provided as a string. If the parameter is provided then the method acts as a setter. */ @@ -24214,7 +24214,7 @@ interface JQuery { } interface IgDoughnutChartSeries { /** - * Gets or sets the current series type. + * Gets or sets the current series type. * * Valid values: * "flat" Series has flat 1-dimensional data. @@ -24222,37 +24222,37 @@ interface IgDoughnutChartSeries { type?: string; /** - * Whether the series should render a tooltip. + * Whether the series should render a tooltip. */ showTooltip?: boolean; /** - * The name of template or the template itself that chart tooltip will use to render. + * The name of template or the template itself that chart tooltip will use to render. */ tooltipTemplate?: string; /** - * Gets or sets the data source for the chart. + * Gets or sets the data source for the chart. */ itemsSource?: any; /** - * Gets or Sets the property name that contains the values. + * Gets or Sets the property name that contains the values. */ valueMemberPath?: string; /** - * Gets or sets the property name that contains the labels. + * Gets or sets the property name that contains the labels. */ labelMemberPath?: string; /** - * Gets or sets the property name that contains the legend labels. + * Gets or sets the property name that contains the legend labels. */ legendLabelMemberPath?: string; /** - * Gets or sets the position of chart labels. + * Gets or sets the position of chart labels. * * Valid values: * "none" @@ -24264,7 +24264,7 @@ interface IgDoughnutChartSeries { labelsPosition?: string; /** - * Gets or sets whether the leader lines are visible. + * Gets or sets whether the leader lines are visible. * * Valid values: * "visible" @@ -24273,12 +24273,12 @@ interface IgDoughnutChartSeries { leaderLineVisibility?: string; /** - * Gets or sets the style for the leader lines. + * Gets or sets the style for the leader lines. */ leaderLineStyle?: any; /** - * Gets or sets what type of leader lines will be used for the outside end labels. + * Gets or sets what type of leader lines will be used for the outside end labels. * * Valid values: * "straight" @@ -24288,17 +24288,17 @@ interface IgDoughnutChartSeries { leaderLineType?: string; /** - * Gets or sets the margin between a label and its leader line. The default is 6 pixels. + * Gets or sets the margin between a label and its leader line. The default is 6 pixels. */ leaderLineMargin?: number; /** - * Gets or sets the threshold value that determines if slices are grouped into the Others slice. + * Gets or sets the threshold value that determines if slices are grouped into the Others slice. */ othersCategoryThreshold?: number; /** - * Gets or sets whether to use numeric or percent-based threshold value. + * Gets or sets whether to use numeric or percent-based threshold value. * * Valid values: * "number" @@ -24307,67 +24307,67 @@ interface IgDoughnutChartSeries { othersCategoryType?: string; /** - * Gets or sets the label of the Others slice. + * Gets or sets the label of the Others slice. */ othersCategoryText?: string; /** - * Gets or sets the legend used for the current chart. + * Gets or sets the legend used for the current chart. */ legend?: any; /** - * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. + * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. */ formatLabel?: any; /** - * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend. + * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend. */ formatLegendLabel?: any; /** - * Gets or sets the pixel amount, by which the labels are offset from the edge of the slices. + * Gets or sets the pixel amount, by which the labels are offset from the edge of the slices. */ labelExtent?: number; /** - * Gets or sets the starting angle of the chart. + * Gets or sets the starting angle of the chart. * The default zero value is equivalent to 3 o'clock. */ startAngle?: number; /** - * Gets or sets the style used when a slice is selected. + * Gets or sets the style used when a slice is selected. */ selectedStyle?: any; /** - * Gets or sets the Brushes property. + * Gets or sets the Brushes property. * The brushes property defines the palette from which automatically assigned slice brushes are selected. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the Outlines property. + * Gets or sets the Outlines property. * The Outlines property defines the palette from which automatically assigned slice outlines are selected. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; /** - * Gets or sets whether all surface interactions with the plot area should be disabled. + * Gets or sets whether all surface interactions with the plot area should be disabled. */ isSurfaceInteractionDisabled?: any; /** - * Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. + * Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. */ radiusFactor?: number; /** - * Option for IgDoughnutChartSeries + * Option for IgDoughnutChartSeries */ [optionName: string]: any; } @@ -24381,85 +24381,85 @@ interface HoleDimensionsChangedEventUIParam { interface IgDoughnutChart { /** - * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * An array of series objects. + * An array of series objects. */ series?: IgDoughnutChartSeries[]; /** - * Gets or sets whether the slices can be selected. + * Gets or sets whether the slices can be selected. */ allowSliceSelection?: boolean; /** - * Gets or sets whether all surface interactions with the plot area should be disabled. + * Gets or sets whether all surface interactions with the plot area should be disabled. */ isSurfaceInteractionDisabled?: any; /** - * Gets or sets whether the slices can be exploded. + * Gets or sets whether the slices can be exploded. */ allowSliceExplosion?: boolean; /** - * Gets or sets the inner extent of the doughnut chart. It is percent from the outer ring's radius. + * Gets or sets the inner extent of the doughnut chart. It is percent from the outer ring's radius. */ innerExtent?: number; /** - * Gets or sets the style used when a slice is selected. + * Gets or sets the style used when a slice is selected. */ selectedStyle?: any; /** - * Gets sets template for tooltip associated with chart item. + * Gets sets template for tooltip associated with chart item. * Example: "Value: $(ValueMemberPathInDataSource)" */ tooltipTemplate?: string; /** - * Gets sets maximum number of displayed records in chart. + * Gets sets maximum number of displayed records in chart. */ maxRecCount?: number; /** - * Gets sets a valid data source. + * Gets sets a valid data source. * That can be instance of array or primitives, array of objects, instance of $.ig.DataSource, or any other data accepted by $.ig.DataSource. * Note: if it is set to string and "dataSourceType" option is not set, then $.ig.JSONPDataSource is used. */ dataSource?: any; /** - * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property + * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property */ dataSourceType?: string; /** - * Gets sets url which is used for sending JSON on request for remote data. + * Gets sets url which is used for sending JSON on request for remote data. */ dataSourceUrl?: string; /** - * See $.ig.DataSource. property in the response specifying the total number of records on the server. + * See $.ig.DataSource. property in the response specifying the total number of records on the server. */ responseTotalRecCountKey?: string; /** - * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. + * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. */ responseDataKey?: string; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24471,7 +24471,7 @@ interface IgDoughnutChart { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24483,7 +24483,7 @@ interface IgDoughnutChart { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left a series and the tooltip is about to hide + * Event fired when the mouse has left a series and the tooltip is about to hide * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24495,7 +24495,7 @@ interface IgDoughnutChart { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24507,22 +24507,22 @@ interface IgDoughnutChart { tooltipHidden?: TooltipHiddenEvent; /** - * Event fired when the control is displayed on a non HTML5 compliant browser + * Event fired when the control is displayed on a non HTML5 compliant browser */ browserNotSupported?: BrowserNotSupportedEvent; /** - * Raised when the slice is clicked. + * Raised when the slice is clicked. */ sliceClick?: SliceClickEvent; /** - * Raised when the dimensions (center point or radius) of the doughnut hole change. + * Raised when the dimensions (center point or radius) of the doughnut hole change. */ holeDimensionsChanged?: HoleDimensionsChangedEvent; /** - * Event which is raised before data binding. + * Event which is raised before data binding. * Return false in order to cancel data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -24531,7 +24531,7 @@ interface IgDoughnutChart { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding. + * Event which is raised after data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. * Use ui.data to obtain reference to array actual data which is displayed by chart. @@ -24540,7 +24540,7 @@ interface IgDoughnutChart { dataBound?: DataBoundEvent; /** - * Event which is raised before tooltip is updated. + * Event which is raised before tooltip is updated. * Return false in order to cancel updating and hide tooltip. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -24553,7 +24553,7 @@ interface IgDoughnutChart { updateTooltip?: UpdateTooltipEvent; /** - * Event which is raised before tooltip is hidden. + * Event which is raised before tooltip is hidden. * Return false in order to cancel hiding and keep tooltip visible. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -24563,85 +24563,85 @@ interface IgDoughnutChart { hideTooltip?: HideTooltipEvent; /** - * Option for igDoughnutChart + * Option for igDoughnutChart */ [optionName: string]: any; } interface IgDoughnutChartMethods { /** - * Adds a new series to the doughnut chart. + * Adds a new series to the doughnut chart. * * @param seriesObj The series object to be added. */ addSeries(seriesObj: Object): void; /** - * Removes the specified series from the doughnut chart. + * Removes the specified series from the doughnut chart. * * @param seriesObj The series object identifying the series to be removed. */ removeSeries(seriesObj: Object): void; /** - * Updates the series with the specified name with the specified new property values. + * Updates the series with the specified name with the specified new property values. * * @param value The series object identifying the series to be updated. */ updateSeries(value: Object): void; /** - * Returns the center of the doughnut chart. + * Returns the center of the doughnut chart. */ getCenterCoordinates(): Object; /** - * Returns the radius of the chart's hole. + * Returns the radius of the chart's hole. */ getHoleRadius(): number; /** - * Returns information about how the doughnut chart is rendered. + * Returns information about how the doughnut chart is rendered. */ exportVisualData(): Object; /** - * Causes all of the series that have pending changes e.g. by changed property values to be rendered immediately. + * Causes all of the series that have pending changes e.g. by changed property values to be rendered immediately. */ flush(): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Find index of item within actual data used by chart. + * Find index of item within actual data used by chart. * * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** - * Get item within actual data used by chart. That is similar to this.getData()[ index ]. + * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * * @param index Index of data item. */ getDataItem(index: Object): Object; /** - * Get reference of actual data used by chart. + * Get reference of actual data used by chart. */ getData(): any[]; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -24649,14 +24649,14 @@ interface IgDoughnutChartMethods { insertItem(item: Object, index: number): Object; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -24664,7 +24664,7 @@ interface IgDoughnutChartMethods { setItem(index: number, item: Object): Object; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -24674,16 +24674,16 @@ interface IgDoughnutChartMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -24692,8 +24692,8 @@ interface IgDoughnutChartMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -24702,12 +24702,12 @@ interface IgDoughnutChartMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Get reference to chart object. + * Get reference to chart object. */ chart(): Object; /** - * Binds data to the chart + * Binds data to the chart */ dataBind(): void; } @@ -25165,12 +25165,12 @@ interface RenderingEvent { interface RenderingEventUIParam { /** - * Used to get a reference to the editor performing rendering. + * Used to get a reference to the editor performing rendering. */ owner?: any; /** - * Used to get a reference to the editor element. + * Used to get a reference to the editor element. */ element?: any; } @@ -25181,17 +25181,17 @@ interface MousedownEvent { interface MousedownEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain a reference to the event target. + * Used to obtain a reference to the event target. */ element?: any; /** - * Used torInput to get a reference to the editor field. + * Used torInput to get a reference to the editor field. */ editorInput?: any; } @@ -25202,17 +25202,17 @@ interface MouseupEvent { interface MouseupEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain a reference to the event target. + * Used to obtain a reference to the event target. */ element?: any; /** - * Used torInput to get a reference to the editor field. + * Used torInput to get a reference to the editor field. */ editorInput?: any; } @@ -25223,17 +25223,17 @@ interface MousemoveEvent { interface MousemoveEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain a reference to the event target. + * Used to obtain a reference to the event target. */ element?: any; /** - * Used torInput to get a reference to the editor field. + * Used torInput to get a reference to the editor field. */ editorInput?: any; } @@ -25244,17 +25244,17 @@ interface MouseoverEvent { interface MouseoverEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain a reference to the event target. + * Used to obtain a reference to the event target. */ element?: any; /** - * Used torInput to get a reference to the editor field. + * Used torInput to get a reference to the editor field. */ editorInput?: any; } @@ -25265,17 +25265,17 @@ interface MouseoutEvent { interface MouseoutEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain a reference to the event target. + * Used to obtain a reference to the event target. */ element?: any; /** - * Used torInput to get a reference to the editor field. + * Used torInput to get a reference to the editor field. */ editorInput?: any; } @@ -25286,12 +25286,12 @@ interface KeydownEvent { interface KeydownEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain value of keyCode. + * Used to obtain value of keyCode. */ key?: any; } @@ -25302,12 +25302,12 @@ interface KeypressEvent { interface KeypressEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain value of keyCode. + * Used to obtain value of keyCode. */ key?: any; } @@ -25318,12 +25318,12 @@ interface KeyupEvent { interface KeyupEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain value of keyCode. + * Used to obtain value of keyCode. */ key?: any; } @@ -25334,22 +25334,22 @@ interface ValueChangingEvent { interface ValueChangingEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain the new value. + * Used to obtain the new value. */ newValue?: any; /** - * Used to obtain the old value. + * Used to obtain the old value. */ oldValue?: any; /** - * Used torInput to obtain reference to the editor input. + * Used torInput to obtain reference to the editor input. */ editorInput?: any; } @@ -25360,29 +25360,29 @@ interface ValueChangedEvent { interface ValueChangedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain the new value. + * Used to obtain the new value. */ newValue?: any; /** - * Used to obtain the original value. + * Used to obtain the original value. */ originalValue?: any; /** - * Used torInput to obtain reference to the editor input. + * Used torInput to obtain reference to the editor input. */ editorInput?: any; } interface IgBaseEditor { /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -25391,7 +25391,7 @@ interface IgBaseEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -25400,50 +25400,50 @@ interface IgBaseEditor { height?: string|number; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * */ value?: any; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is false, and editor has no value, then value is set to an empty string. * */ allowNullValue?: boolean; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -25451,7 +25451,7 @@ interface IgBaseEditor { validatorOptions?: any; /** - * Event which is raised before rendering of the editor completes. + * Event which is raised before rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -25459,7 +25459,7 @@ interface IgBaseEditor { rendering?: RenderingEvent; /** - * Event which is raised after rendering of the editor completes. + * Event which is raised after rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -25467,7 +25467,7 @@ interface IgBaseEditor { rendered?: RenderedEvent; /** - * Event which is raised on mousedown event. + * Event which is raised on mousedown event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25476,7 +25476,7 @@ interface IgBaseEditor { mousedown?: MousedownEvent; /** - * Event which is raised on mouseup event. + * Event which is raised on mouseup event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25485,7 +25485,7 @@ interface IgBaseEditor { mouseup?: MouseupEvent; /** - * Event which is raised on mousemove at any part of editor including drop-down list. + * Event which is raised on mousemove at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25494,7 +25494,7 @@ interface IgBaseEditor { mousemove?: MousemoveEvent; /** - * Event which is raised on mouseover at any part of editor including drop-down list. + * Event which is raised on mouseover at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25503,7 +25503,7 @@ interface IgBaseEditor { mouseover?: MouseoverEvent; /** - * Event which is raised on mouseleave at any part of editor including drop-down list. + * Event which is raised on mouseleave at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25512,7 +25512,7 @@ interface IgBaseEditor { mouseout?: MouseoutEvent; /** - * Event which is raised when input field of editor loses focus. + * Event which is raised when input field of editor loses focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25521,7 +25521,7 @@ interface IgBaseEditor { blur?: BlurEvent; /** - * Event which is raised when input field of editor gets focus. + * Event which is raised when input field of editor gets focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -25530,7 +25530,7 @@ interface IgBaseEditor { focus?: FocusEvent; /** - * Event which is raised on keydown event. + * Event which is raised on keydown event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -25540,7 +25540,7 @@ interface IgBaseEditor { keydown?: KeydownEvent; /** - * Event which is raised on keypress event. + * Event which is raised on keypress event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -25550,7 +25550,7 @@ interface IgBaseEditor { keypress?: KeypressEvent; /** - * Event which is raised on keyup event. + * Event which is raised on keyup event. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igEditor. @@ -25559,7 +25559,7 @@ interface IgBaseEditor { keyup?: KeyupEvent; /** - * Event which is raised before the editor value is changed. + * Event which is raised before the editor value is changed. * Return false in order to cancel change. * It can be raised after loosing focus or on spin events. * Function takes arguments evt and ui. @@ -25571,7 +25571,7 @@ interface IgBaseEditor { valueChanging?: ValueChangingEvent; /** - * Event which is raised after the editor value is changed. It can be raised after loosing focus or on spin events. + * Event which is raised after the editor value is changed. It can be raised after loosing focus or on spin events. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.newValue to obtain the new value. @@ -25581,13 +25581,13 @@ interface IgBaseEditor { valueChanged?: ValueChangedEvent; /** - * Option for igBaseEditor + * Option for igBaseEditor */ [optionName: string]: any; } interface IgBaseEditorMethods { /** - * Gets/Sets name attribute applied to the editor element. + * Gets/Sets name attribute applied to the editor element. * * @param newValue The new input name. */ @@ -25595,54 +25595,54 @@ interface IgBaseEditorMethods { value(newValue: Object): void; /** - * Gets the input element of the editor. + * Gets the input element of the editor. */ field(): string; /** - * Gets a reference to the jQuery element that wraps the editor. + * Gets a reference to the jQuery element that wraps the editor. */ editorContainer(): string; /** - * Gets whether the editor has focus. + * Gets whether the editor has focus. */ hasFocus(): boolean; /** - * Sets focus to the editor after the specified delay. + * Sets focus to the editor after the specified delay. * * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; /** - * Hides the editor. + * Hides the editor. */ hide(): void; /** - * Shows the editor. + * Shows the editor. */ show(): void; /** - * Gets a reference to [igValidator](ui.igvalidator) used by the editor. + * Gets a reference to [igValidator](ui.igvalidator) used by the editor. */ validator(): Object; /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; /** - * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). + * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). */ validate(): boolean; /** - * Destroys the widget + * Destroys the widget */ destroy(): void; } @@ -25656,17 +25656,17 @@ interface DropDownListOpeningEvent { interface DropDownListOpeningEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; } @@ -25677,17 +25677,17 @@ interface DropDownListOpenedEvent { interface DropDownListOpenedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; } @@ -25698,17 +25698,17 @@ interface DropDownListClosingEvent { interface DropDownListClosingEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; } @@ -25719,17 +25719,17 @@ interface DropDownListClosedEvent { interface DropDownListClosedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; } @@ -25740,22 +25740,22 @@ interface DropDownItemSelectingEvent { interface DropDownItemSelectingEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; /** - * Used to obtain reference to the list item which is about to be selected. + * Used to obtain reference to the list item which is about to be selected. */ item?: any; } @@ -25766,22 +25766,22 @@ interface DropDownItemSelectedEvent { interface DropDownItemSelectedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used torInput to obtain reference to the editable input + * Used torInput to obtain reference to the editable input */ editorInput?: any; /** - * Used to obtain reference to the list contaier. + * Used to obtain reference to the list contaier. */ list?: any; /** - * Used to obtain reference to the list item which is selected. + * Used to obtain reference to the list item which is selected. */ item?: any; } @@ -25792,24 +25792,24 @@ interface TextChangedEvent { interface TextChangedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain new text + * Used to obtain new text */ text?: any; /** - * Used to obtain the old text. + * Used to obtain the old text. */ oldText?: any; } interface IgTextEditor { /** - * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. + * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * * @@ -25821,26 +25821,26 @@ interface IgTextEditor { buttonType?: string; /** - * Gets/Sets list of items which are used as a source for the drop-down list. + * Gets/Sets list of items which are used as a source for the drop-down list. * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. * */ listItems?: any[]; /** - * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. + * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. * */ listWidth?: number; /** - * Gets/Sets the hover/unhover animation duration of a drop-down list item. + * Gets/Sets the hover/unhover animation duration of a drop-down list item. * */ listItemHoverDuration?: number; /** - * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. + * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. * If the option is set to false the editor will attach the drop-down list element to the editor container * If the option is set to true the editor will attach its drop-down list to as a child of the body. * Note! This option can not be set runtime. @@ -25849,13 +25849,13 @@ interface IgTextEditor { dropDownAttachedToBody?: boolean; /** - * Gets/Sets show/hide drop-down list animation duration in milliseconds. + * Gets/Sets show/hide drop-down list animation duration in milliseconds. * */ dropDownAnimationDuration?: number; /** - * Gets the number of the items to be shown at once when the drop-down list get opened. + * Gets the number of the items to be shown at once when the drop-down list get opened. * Notes: * This option is overwritten if the number of list items is less than the set value. In that case the drop-down list displays all the items. * This option can not be set runtime. @@ -25864,7 +25864,7 @@ interface IgTextEditor { visibleItemsCount?: number; /** - * Gets/Sets the ability of the editor to allow entering only specific characters in the input-field from the keyboard and on paste. + * Gets/Sets the ability of the editor to allow entering only specific characters in the input-field from the keyboard and on paste. * Notes: * If both "excludeKeys" and "includeKeys" options are used, then "excludeKeys" has priority and includeKeys options is not respected. * The option is case sensitive! If the option is set runtime it's not applied on the current value. @@ -25873,7 +25873,7 @@ interface IgTextEditor { includeKeys?: string; /** - * Gets/Sets the ability of the editor to prevent entering specific characters from the keyboard or on paste. + * Gets/Sets the ability of the editor to prevent entering specific characters from the keyboard or on paste. * Notes: * If both "excludeKeys" and "includeKeys" options are used, then "excludeKeys" has priority and includeKeys options is not respected. * The option is case sensitive! If the option is set runtime it's not applied on the current value. @@ -25882,7 +25882,7 @@ interface IgTextEditor { excludeKeys?: string; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -25893,13 +25893,13 @@ interface IgTextEditor { textAlign?: string; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -25911,7 +25911,7 @@ interface IgTextEditor { selectionOnFocus?: string; /** - * Gets the text mode of the editor such as: single-line text editor, password editor or multiline editor. That option has effect only on initialization. If based element (selector) is TEXTAREA, then it is used as input-field. + * Gets the text mode of the editor such as: single-line text editor, password editor or multiline editor. That option has effect only on initialization. If based element (selector) is TEXTAREA, then it is used as input-field. * * * Valid values: @@ -25922,31 +25922,31 @@ interface IgTextEditor { textMode?: string; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. When the last item is reached and the spin down is clicked, the first item gets hovered and vice versa. This option has no effect there is no drop-down list. + * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. When the last item is reached and the spin down is clicked, the first item gets hovered and vice versa. This option has no effect there is no drop-down list. * */ spinWrapAround?: boolean; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed * */ isLimitedToListValues?: boolean; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. + * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * * * Valid values: @@ -25957,14 +25957,14 @@ interface IgTextEditor { dropDownOrientation?: string; /** - * Gets/Sets the maximum length of a text which can be entered by the user. + * Gets/Sets the maximum length of a text which can be entered by the user. * Negative values or 0 disables that behavior. If set at runtime the editor doesn't apply the option to the cuurent value. * */ maxLength?: number; /** - * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. + * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. * Note! In case there are no list items - the editor will reamin readonly * Note! This option can not be set runtime. * @@ -25972,33 +25972,33 @@ interface IgTextEditor { dropDownOnReadOnly?: boolean; /** - * Gets/Sets the ability to convert the input characters to upper case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. + * Gets/Sets the ability to convert the input characters to upper case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. * Note! When the option is set at runtime the editor is not changing the current value. * */ toUpper?: boolean; /** - * Gets/Sets the ability to convert the input characters to lower case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. + * Gets/Sets the ability to convert the input characters to lower case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. * Note! When the option is set at runtime the editor is not changing the current value. * */ toLower?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -26007,7 +26007,7 @@ interface IgTextEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -26016,50 +26016,50 @@ interface IgTextEditor { height?: string|number; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * */ value?: any; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is false, and editor has no value, then value is set to an empty string. * */ allowNullValue?: boolean; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -26067,7 +26067,7 @@ interface IgTextEditor { validatorOptions?: any; /** - * Event which is raised when the drop down is opening. + * Event which is raised when the drop down is opening. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26076,7 +26076,7 @@ interface IgTextEditor { dropDownListOpening?: DropDownListOpeningEvent; /** - * Event which is raised after the drop down is opened. + * Event which is raised after the drop down is opened. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26085,7 +26085,7 @@ interface IgTextEditor { dropDownListOpened?: DropDownListOpenedEvent; /** - * Event which is raised when the drop down is closing. + * Event which is raised when the drop down is closing. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26094,7 +26094,7 @@ interface IgTextEditor { dropDownListClosing?: DropDownListClosingEvent; /** - * Event which is raised after the drop down is closed. + * Event which is raised after the drop down is closed. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26103,7 +26103,7 @@ interface IgTextEditor { dropDownListClosed?: DropDownListClosedEvent; /** - * Event which is raised when an item in the drop down list is being selected. + * Event which is raised when an item in the drop down list is being selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26113,7 +26113,7 @@ interface IgTextEditor { dropDownItemSelecting?: DropDownItemSelectingEvent; /** - * Event which is raised after an item in the drop down list is selected. + * Event which is raised after an item in the drop down list is selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26123,7 +26123,7 @@ interface IgTextEditor { dropDownItemSelected?: DropDownItemSelectedEvent; /** - * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, + * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, * when the clear button is clicked or when an item from a list is selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. @@ -26133,7 +26133,7 @@ interface IgTextEditor { textChanged?: TextChangedEvent; /** - * Event which is raised before rendering of the editor completes. + * Event which is raised before rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -26141,7 +26141,7 @@ interface IgTextEditor { rendering?: RenderingEvent; /** - * Event which is raised after rendering of the editor completes. + * Event which is raised after rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -26149,7 +26149,7 @@ interface IgTextEditor { rendered?: RenderedEvent; /** - * Event which is raised on mousedown event. + * Event which is raised on mousedown event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26158,7 +26158,7 @@ interface IgTextEditor { mousedown?: MousedownEvent; /** - * Event which is raised on mouseup event. + * Event which is raised on mouseup event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26167,7 +26167,7 @@ interface IgTextEditor { mouseup?: MouseupEvent; /** - * Event which is raised on mousemove at any part of editor including drop-down list. + * Event which is raised on mousemove at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26176,7 +26176,7 @@ interface IgTextEditor { mousemove?: MousemoveEvent; /** - * Event which is raised on mouseover at any part of editor including drop-down list. + * Event which is raised on mouseover at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26185,7 +26185,7 @@ interface IgTextEditor { mouseover?: MouseoverEvent; /** - * Event which is raised on mouseleave at any part of editor including drop-down list. + * Event which is raised on mouseleave at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26194,7 +26194,7 @@ interface IgTextEditor { mouseout?: MouseoutEvent; /** - * Event which is raised when input field of editor loses focus. + * Event which is raised when input field of editor loses focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26203,7 +26203,7 @@ interface IgTextEditor { blur?: BlurEvent; /** - * Event which is raised when input field of editor gets focus. + * Event which is raised when input field of editor gets focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -26212,7 +26212,7 @@ interface IgTextEditor { focus?: FocusEvent; /** - * Event which is raised on keydown event. + * Event which is raised on keydown event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -26222,7 +26222,7 @@ interface IgTextEditor { keydown?: KeydownEvent; /** - * Event which is raised on keypress event. + * Event which is raised on keypress event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -26232,7 +26232,7 @@ interface IgTextEditor { keypress?: KeypressEvent; /** - * Event which is raised on keyup event. + * Event which is raised on keyup event. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igEditor. @@ -26241,7 +26241,7 @@ interface IgTextEditor { keyup?: KeyupEvent; /** - * Event which is raised before the editor value is changed. + * Event which is raised before the editor value is changed. * Return false in order to cancel change. * It can be raised after loosing focus or on spin events. * Function takes arguments evt and ui. @@ -26253,7 +26253,7 @@ interface IgTextEditor { valueChanging?: ValueChangingEvent; /** - * Event which is raised after the editor value is changed. It can be raised after loosing focus or on spin events. + * Event which is raised after the editor value is changed. It can be raised after loosing focus or on spin events. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.newValue to obtain the new value. @@ -26263,48 +26263,48 @@ interface IgTextEditor { valueChanged?: ValueChangedEvent; /** - * Option for igTextEditor + * Option for igTextEditor */ [optionName: string]: any; } interface IgTextEditorMethods { /** - * Gets the visible text in the editor. + * Gets the visible text in the editor. */ displayValue(): string; /** - * Gets reference to jquery object which is used as container of drop-down list. + * Gets reference to jquery object which is used as container of drop-down list. */ dropDownContainer(): string; /** - * Shows the drop down list. + * Shows the drop down list. */ showDropDown(): void; /** - * Hides the drop down list. + * Hides the drop down list. */ hideDropDown(): void; /** - * Returns a reference to the drop-down button UI element of the editor. + * Returns a reference to the drop-down button UI element of the editor. */ dropDownButton(): string; /** - * Returns if the drop-down list is visible. + * Returns if the drop-down list is visible. */ dropDownVisible(): boolean; /** - * Returns a reference to the clear button UI element of the editor. + * Returns a reference to the clear button UI element of the editor. */ clearButton(): string; /** - * Finds index of list item by text that matches with the search parameters. + * Finds index of list item by text that matches with the search parameters. * * @param text The text to search for in the drop down list. * @param matchType The rule that is applied for searching the text. @@ -26312,42 +26312,42 @@ interface IgTextEditorMethods { findListItemIndex(text: string, matchType?: Object): number; /** - * Gets the index of the selected list item. Sets selected item by index. + * Gets the index of the selected list item. Sets selected item by index. * * @param index The index of the item that needs to be selected. */ selectedListIndex(index?: number): number; /** - * Gets the selected list item. + * Gets the selected list item. */ getSelectedListItem(): string; /** - * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. + * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. */ getSelectedText(): string; /** - * Gets the start index of the selected text in the editor. + * Gets the start index of the selected text in the editor. */ getSelectionStart(): number; /** - * Gets the end index of the selected text in the editor. + * Gets the end index of the selected text in the editor. */ getSelectionEnd(): number; /** - * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. - * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. + * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ insert(string: string): void; /** - * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. + * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * * @param start Start of the selection. * @param end End of the selection. @@ -26355,27 +26355,27 @@ interface IgTextEditorMethods { select(start: number, end: number): void; /** - * Hovers the previous item in the drop-down list if the list is opened. + * Hovers the previous item in the drop-down list if the list is opened. */ spinUp(): void; /** - * Hovers the next item in the drop-down list if the list is opened. + * Hovers the next item in the drop-down list if the list is opened. */ spinDown(): void; /** - * Returns a reference to the spin up UI element of the editor. + * Returns a reference to the spin up UI element of the editor. */ spinUpButton(): string; /** - * Returns a reference to the spin down UI element of the editor. + * Returns a reference to the spin down UI element of the editor. */ spinDownButton(): string; /** - * Gets/Sets name attribute applied to the editor element. + * Gets/Sets name attribute applied to the editor element. * * @param newValue The new input name. */ @@ -26383,54 +26383,54 @@ interface IgTextEditorMethods { value(newValue: Object): void; /** - * Gets the input element of the editor. + * Gets the input element of the editor. */ field(): string; /** - * Gets a reference to the jQuery element that wraps the editor. + * Gets a reference to the jQuery element that wraps the editor. */ editorContainer(): string; /** - * Gets whether the editor has focus. + * Gets whether the editor has focus. */ hasFocus(): boolean; /** - * Sets focus to the editor after the specified delay. + * Sets focus to the editor after the specified delay. * * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; /** - * Hides the editor. + * Hides the editor. */ hide(): void; /** - * Shows the editor. + * Shows the editor. */ show(): void; /** - * Gets a reference to [igValidator](ui.igvalidator) used by the editor. + * Gets a reference to [igValidator](ui.igvalidator) used by the editor. */ validator(): Object; /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; /** - * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). + * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). */ validate(): boolean; /** - * Destroys the widget + * Destroys the widget */ destroy(): void; } @@ -26440,20 +26440,20 @@ interface JQuery { interface IgNumericEditor { /** - * Gets/Sets list of items which are used as a source for the drop-down list. + * Gets/Sets list of items which are used as a source for the drop-down list. * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. * */ listItems?: any[]; /** - * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. + * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets/Sets the character, which is used as negative sign. + * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -26461,7 +26461,7 @@ interface IgNumericEditor { negativeSign?: string; /** - * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. + * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -26469,7 +26469,7 @@ interface IgNumericEditor { negativePattern?: string; /** - * Gets/Sets the character, which is used as decimal separator. + * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -26477,7 +26477,7 @@ interface IgNumericEditor { decimalSeparator?: string; /** - * Gets/Sets the character, which is used as separator for groups (like thousands). + * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -26486,7 +26486,7 @@ interface IgNumericEditor { groupSeparator?: string; /** - * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. + * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. * The "groupSeparator" is inserted between groups. * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). @@ -26498,7 +26498,7 @@ interface IgNumericEditor { groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -26507,7 +26507,7 @@ interface IgNumericEditor { maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. @@ -26518,7 +26518,7 @@ interface IgNumericEditor { minDecimals?: number; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -26529,7 +26529,7 @@ interface IgNumericEditor { textAlign?: string; /** - * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. + * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * @@ -26550,32 +26550,32 @@ interface IgNumericEditor { dataMode?: string; /** - * Gets/Sets the minimum value which can be entered in the editor by the end user. + * Gets/Sets the minimum value which can be entered in the editor by the end user. * */ minValue?: number; /** - * Gets/Sets the maximum value which can be entered in the editor by the end user. + * Gets/Sets the maximum value which can be entered in the editor by the end user. * */ maxValue?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is disabled, and editor has no value, then value is set to 0 (or minValue/maxValue). * */ allowNullValue?: boolean; /** - * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igNumericEditor#options:buttonType) or [spinUp](ui.igNumericEditor#methods:spinUp) and [spinDown](ui.igNumericEditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. + * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igNumericEditor#options:buttonType) or [spinUp](ui.igNumericEditor#methods:spinUp) and [spinDown](ui.igNumericEditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. * */ spinDelta?: number; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * @@ -26591,50 +26591,50 @@ interface IgNumericEditor { scientificFormat?: string; /** - * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. * */ spinWrapAround?: boolean; /** - * Removed from numeric editor options + * Removed from numeric editor options */ maxLength?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ excludeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ includeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toLower?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toUpper?: any; /** - * + * */ textMode?: any; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * * */ value?: any; /** - * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. + * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * * @@ -26646,19 +26646,19 @@ interface IgNumericEditor { buttonType?: string; /** - * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. + * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. * */ listWidth?: number; /** - * Gets/Sets the hover/unhover animation duration of a drop-down list item. + * Gets/Sets the hover/unhover animation duration of a drop-down list item. * */ listItemHoverDuration?: number; /** - * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. + * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. * If the option is set to false the editor will attach the drop-down list element to the editor container * If the option is set to true the editor will attach its drop-down list to as a child of the body. * Note! This option can not be set runtime. @@ -26667,13 +26667,13 @@ interface IgNumericEditor { dropDownAttachedToBody?: boolean; /** - * Gets/Sets show/hide drop-down list animation duration in milliseconds. + * Gets/Sets show/hide drop-down list animation duration in milliseconds. * */ dropDownAnimationDuration?: number; /** - * Gets the number of the items to be shown at once when the drop-down list get opened. + * Gets the number of the items to be shown at once when the drop-down list get opened. * Notes: * This option is overwritten if the number of list items is less than the set value. In that case the drop-down list displays all the items. * This option can not be set runtime. @@ -26682,13 +26682,13 @@ interface IgNumericEditor { visibleItemsCount?: number; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -26700,25 +26700,25 @@ interface IgNumericEditor { selectionOnFocus?: string; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed * */ isLimitedToListValues?: boolean; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. + * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * * * Valid values: @@ -26729,7 +26729,7 @@ interface IgNumericEditor { dropDownOrientation?: string; /** - * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. + * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. * Note! In case there are no list items - the editor will reamin readonly * Note! This option can not be set runtime. * @@ -26737,19 +26737,19 @@ interface IgNumericEditor { dropDownOnReadOnly?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -26758,7 +26758,7 @@ interface IgNumericEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -26767,37 +26767,37 @@ interface IgNumericEditor { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -26805,7 +26805,7 @@ interface IgNumericEditor { validatorOptions?: any; /** - * Event which is raised when the drop down is opening. + * Event which is raised when the drop down is opening. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26814,7 +26814,7 @@ interface IgNumericEditor { dropDownListOpening?: DropDownListOpeningEvent; /** - * Event which is raised after the drop down is opened. + * Event which is raised after the drop down is opened. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26823,7 +26823,7 @@ interface IgNumericEditor { dropDownListOpened?: DropDownListOpenedEvent; /** - * Event which is raised when the drop down is closing. + * Event which is raised when the drop down is closing. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26832,7 +26832,7 @@ interface IgNumericEditor { dropDownListClosing?: DropDownListClosingEvent; /** - * Event which is raised after the drop down is closed. + * Event which is raised after the drop down is closed. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26841,7 +26841,7 @@ interface IgNumericEditor { dropDownListClosed?: DropDownListClosedEvent; /** - * Event which is raised when an item in the drop down list is being selected. + * Event which is raised when an item in the drop down list is being selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26851,7 +26851,7 @@ interface IgNumericEditor { dropDownItemSelecting?: DropDownItemSelectingEvent; /** - * Event which is raised after an item in the drop down list is selected. + * Event which is raised after an item in the drop down list is selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -26861,7 +26861,7 @@ interface IgNumericEditor { dropDownItemSelected?: DropDownItemSelectedEvent; /** - * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, + * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, * when the clear button is clicked or when an item from a list is selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. @@ -26871,20 +26871,20 @@ interface IgNumericEditor { textChanged?: TextChangedEvent; /** - * Option for igNumericEditor + * Option for igNumericEditor */ [optionName: string]: any; } interface IgNumericEditorMethods { /** - * Gets/Sets editor value. + * Gets/Sets editor value. * * @param newValue New editor value. */ value(newValue?: number): number; /** - * Finds index of list item by text that matches with the search parameters. + * Finds index of list item by text that matches with the search parameters. * * @param number The text to search for. */ @@ -26894,91 +26894,91 @@ interface IgNumericEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * Increments value in editor according to the parameter. * * @param delta Increments value. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * Decrements value in editor according to the parameter. * * @param delta Decrement value. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexDown(): void; /** - * Gets current regional. + * Gets current regional. */ getRegionalOption(): string; /** - * Gets the visible text in the editor. + * Gets the visible text in the editor. */ displayValue(): string; /** - * Gets reference to jquery object which is used as container of drop-down list. + * Gets reference to jquery object which is used as container of drop-down list. */ dropDownContainer(): string; /** - * Shows the drop down list. + * Shows the drop down list. */ showDropDown(): void; /** - * Hides the drop down list. + * Hides the drop down list. */ hideDropDown(): void; /** - * Returns a reference to the drop-down button UI element of the editor. + * Returns a reference to the drop-down button UI element of the editor. */ dropDownButton(): string; /** - * Returns if the drop-down list is visible. + * Returns if the drop-down list is visible. */ dropDownVisible(): boolean; /** - * Returns a reference to the clear button UI element of the editor. + * Returns a reference to the clear button UI element of the editor. */ clearButton(): string; /** - * Gets the index of the selected list item. Sets selected item by index. + * Gets the index of the selected list item. Sets selected item by index. * * @param index The index of the item that needs to be selected. */ selectedListIndex(index?: number): number; /** - * Gets the selected list item. + * Gets the selected list item. */ getSelectedListItem(): string; /** - * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. - * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. + * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ insert(string: string): void; /** - * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. + * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * * @param start Start of the selection. * @param end End of the selection. @@ -26986,12 +26986,12 @@ interface IgNumericEditorMethods { select(start: number, end: number): void; /** - * Returns a reference to the spin up UI element of the editor. + * Returns a reference to the spin up UI element of the editor. */ spinUpButton(): string; /** - * Returns a reference to the spin down UI element of the editor. + * Returns a reference to the spin down UI element of the editor. */ spinDownButton(): string; } @@ -27001,7 +27001,7 @@ interface JQuery { interface IgCurrencyEditor { /** - * Gets/Sets the string, which is used as positive pattern. The "n" flag represents the value of number. + * Gets/Sets the string, which is used as positive pattern. The "n" flag represents the value of number. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27009,26 +27009,26 @@ interface IgCurrencyEditor { positivePattern?: string; /** - * Gets/Sets a string that is used as the currency symbol that is shown in display mode. + * Gets/Sets a string that is used as the currency symbol that is shown in display mode. * */ currencySymbol?: string; /** - * Gets/Sets list of items which are used as a source for the drop-down list. + * Gets/Sets list of items which are used as a source for the drop-down list. * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. * */ listItems?: any[]; /** - * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. + * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets/Sets the character, which is used as negative sign. + * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27036,7 +27036,7 @@ interface IgCurrencyEditor { negativeSign?: string; /** - * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. + * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27044,7 +27044,7 @@ interface IgCurrencyEditor { negativePattern?: string; /** - * Gets/Sets the character, which is used as decimal separator. + * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27052,7 +27052,7 @@ interface IgCurrencyEditor { decimalSeparator?: string; /** - * Gets/Sets the character, which is used as separator for groups (like thousands). + * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -27061,7 +27061,7 @@ interface IgCurrencyEditor { groupSeparator?: string; /** - * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. + * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. * The "groupSeparator" is inserted between groups. * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). @@ -27073,7 +27073,7 @@ interface IgCurrencyEditor { groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -27082,7 +27082,7 @@ interface IgCurrencyEditor { maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. @@ -27093,7 +27093,7 @@ interface IgCurrencyEditor { minDecimals?: number; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -27104,7 +27104,7 @@ interface IgCurrencyEditor { textAlign?: string; /** - * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. + * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * @@ -27125,32 +27125,32 @@ interface IgCurrencyEditor { dataMode?: string; /** - * Gets/Sets the minimum value which can be entered in the editor by the end user. + * Gets/Sets the minimum value which can be entered in the editor by the end user. * */ minValue?: number; /** - * Gets/Sets the maximum value which can be entered in the editor by the end user. + * Gets/Sets the maximum value which can be entered in the editor by the end user. * */ maxValue?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is disabled, and editor has no value, then value is set to 0 (or minValue/maxValue). * */ allowNullValue?: boolean; /** - * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igNumericEditor#options:buttonType) or [spinUp](ui.igNumericEditor#methods:spinUp) and [spinDown](ui.igNumericEditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. + * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igNumericEditor#options:buttonType) or [spinUp](ui.igNumericEditor#methods:spinUp) and [spinDown](ui.igNumericEditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. * */ spinDelta?: number; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * @@ -27166,50 +27166,50 @@ interface IgCurrencyEditor { scientificFormat?: string; /** - * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. * */ spinWrapAround?: boolean; /** - * Removed from numeric editor options + * Removed from numeric editor options */ maxLength?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ excludeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ includeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toLower?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toUpper?: any; /** - * + * */ textMode?: any; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * * */ value?: any; /** - * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. + * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * * @@ -27221,19 +27221,19 @@ interface IgCurrencyEditor { buttonType?: string; /** - * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. + * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. * */ listWidth?: number; /** - * Gets/Sets the hover/unhover animation duration of a drop-down list item. + * Gets/Sets the hover/unhover animation duration of a drop-down list item. * */ listItemHoverDuration?: number; /** - * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. + * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. * If the option is set to false the editor will attach the drop-down list element to the editor container * If the option is set to true the editor will attach its drop-down list to as a child of the body. * Note! This option can not be set runtime. @@ -27242,13 +27242,13 @@ interface IgCurrencyEditor { dropDownAttachedToBody?: boolean; /** - * Gets/Sets show/hide drop-down list animation duration in milliseconds. + * Gets/Sets show/hide drop-down list animation duration in milliseconds. * */ dropDownAnimationDuration?: number; /** - * Gets the number of the items to be shown at once when the drop-down list get opened. + * Gets the number of the items to be shown at once when the drop-down list get opened. * Notes: * This option is overwritten if the number of list items is less than the set value. In that case the drop-down list displays all the items. * This option can not be set runtime. @@ -27257,13 +27257,13 @@ interface IgCurrencyEditor { visibleItemsCount?: number; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -27275,25 +27275,25 @@ interface IgCurrencyEditor { selectionOnFocus?: string; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed * */ isLimitedToListValues?: boolean; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. + * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * * * Valid values: @@ -27304,7 +27304,7 @@ interface IgCurrencyEditor { dropDownOrientation?: string; /** - * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. + * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. * Note! In case there are no list items - the editor will reamin readonly * Note! This option can not be set runtime. * @@ -27312,19 +27312,19 @@ interface IgCurrencyEditor { dropDownOnReadOnly?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -27333,7 +27333,7 @@ interface IgCurrencyEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -27342,37 +27342,37 @@ interface IgCurrencyEditor { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -27380,27 +27380,27 @@ interface IgCurrencyEditor { validatorOptions?: any; /** - * Option for igCurrencyEditor + * Option for igCurrencyEditor */ [optionName: string]: any; } interface IgCurrencyEditorMethods { /** - * Gets/sets a string that is used as the currency symbol shown with the number in the input. The value provided as a param is propagated to the currencySymbol option and thus has the same priority as the option. + * Gets/sets a string that is used as the currency symbol shown with the number in the input. The value provided as a param is propagated to the currencySymbol option and thus has the same priority as the option. * * @param symbol New currency symbol. */ currencySymbol(symbol?: Object): string; /** - * Gets/Sets editor value. + * Gets/Sets editor value. * * @param newValue New editor value. */ value(newValue?: number): number; /** - * Finds index of list item by text that matches with the search parameters. + * Finds index of list item by text that matches with the search parameters. * * @param number The text to search for. */ @@ -27410,31 +27410,31 @@ interface IgCurrencyEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * Increments value in editor according to the parameter. * * @param delta Increments value. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * Decrements value in editor according to the parameter. * * @param delta Decrement value. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexDown(): void; /** - * Gets current regional. + * Gets current regional. */ getRegionalOption(): string; } @@ -27444,7 +27444,7 @@ interface JQuery { interface IgPercentEditor { /** - * Gets/Sets the pattern for positive numeric values, which is used in display (no focus) state. + * Gets/Sets the pattern for positive numeric values, which is used in display (no focus) state. * If you use the "en-US" culture the default value for "positivePattern" will be "n$" where the "$" flag represents the "numericSymbol" and the "n" flag represents the value of the number. * Note: this option has priority over possible regional settings. * @@ -27452,14 +27452,14 @@ interface IgPercentEditor { positivePattern?: string; /** - * Gets/Sets the symbol, which is used in display (no focus) state. + * Gets/Sets the symbol, which is used in display (no focus) state. * Note: this option has priority over possible regional settings. * */ percentSymbol?: string; /** - * Gets/Sets the factor which is used for the get and set of the "value" method. + * Gets/Sets the factor which is used for the get and set of the "value" method. * On get the number (string) entered by the user is divided by that factor and on set the number (string) displayed in the editor is multiplied by that factor. * For example, if the factor is 100 and the "value" is set to 0.123, then the editor will show string "12.3". * Possible values: 1 or 100. @@ -27469,7 +27469,7 @@ interface IgPercentEditor { displayFactor?: number; /** - * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. + * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. * @@ -27490,26 +27490,26 @@ interface IgPercentEditor { dataMode?: string; /** - * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igpercenteditor#options:buttonType) or [spinUp](ui.igpercenteditor#methods:spinUp) and [spinDown](ui.igpercenteditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. + * Gets/Sets the default delta-value which is used with "spin" [buttonType](ui.igpercenteditor#options:buttonType) or [spinUp](ui.igpercenteditor#methods:spinUp) and [spinDown](ui.igpercenteditor#methods:spinDown) methods to increment or decrement value in the editor. The value can not be negative. Non integer value is supported only for dataMode double and float. * */ spinDelta?: number; /** - * Gets/Sets list of items which are used as a source for the drop-down list. + * Gets/Sets list of items which are used as a source for the drop-down list. * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. * */ listItems?: any[]; /** - * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. + * Gets/Sets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets/Sets the character, which is used as negative sign. + * Gets/Sets the character, which is used as negative sign. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27517,7 +27517,7 @@ interface IgPercentEditor { negativeSign?: string; /** - * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. + * Gets/Sets the string, which is used as negative pattern. The "n" flag represents the value of number. The "-" and "()" flags are static part of pattern. * Note: This option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27525,7 +27525,7 @@ interface IgPercentEditor { negativePattern?: string; /** - * Gets/Sets the character, which is used as decimal separator. + * Gets/Sets the character, which is used as decimal separator. * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. * @@ -27533,7 +27533,7 @@ interface IgPercentEditor { decimalSeparator?: string; /** - * Gets/Sets the character, which is used as separator for groups (like thousands). + * Gets/Sets the character, which is used as separator for groups (like thousands). * That option has effect only in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -27542,7 +27542,7 @@ interface IgPercentEditor { groupSeparator?: string; /** - * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. + * (array of number objects) Gets/Sets the number of digits in the integer part of a number, which are divided into groups. * The "groupSeparator" is inserted between groups. * If the sum of all values in array is smaller than the length of integer part, then the last item in array is used for all following groups. * Count of groups starts from the decimal point (from right to left). @@ -27554,7 +27554,7 @@ interface IgPercentEditor { groups?: any[]; /** - * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). + * Gets/Sets the maximum number of decimal places which are used in display mode(no focus). * Note: this option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. * Note: Even if the default value is null - if internationalization file is provided and it contains default values for those properties the values are imlicitly set. @@ -27563,7 +27563,7 @@ interface IgPercentEditor { maxDecimals?: number; /** - * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. + * Gets/Sets the minimum number of decimal places which are used in display (no focus) state. * If number of digits in fractional part of number is less than the value of this option, then the "0" characters are used to fill missing digits. * Note: This option has priority over possible regional settings. * Note: In case of min decimals value higher than max decimals - max decimals are equaled to min decimals property. @@ -27574,7 +27574,7 @@ interface IgPercentEditor { minDecimals?: number; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -27585,26 +27585,26 @@ interface IgPercentEditor { textAlign?: string; /** - * Gets/Sets the minimum value which can be entered in the editor by the end user. + * Gets/Sets the minimum value which can be entered in the editor by the end user. * */ minValue?: number; /** - * Gets/Sets the maximum value which can be entered in the editor by the end user. + * Gets/Sets the maximum value which can be entered in the editor by the end user. * */ maxValue?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is disabled, and editor has no value, then value is set to 0 (or minValue/maxValue). * */ allowNullValue?: boolean; /** - * Gets/Sets support for scientific format in edit mode. + * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. * @@ -27620,50 +27620,50 @@ interface IgPercentEditor { scientificFormat?: string; /** - * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. + * Gets/Set the ability of the editor to automatically set value in the editor to the opposite side of the limit, when the spin action reaches minimum or maximum limit. * */ spinWrapAround?: boolean; /** - * Removed from numeric editor options + * Removed from numeric editor options */ maxLength?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ excludeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ includeKeys?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toLower?: any; /** - * Removed from numeric editor options + * Removed from numeric editor options */ toUpper?: any; /** - * + * */ textMode?: any; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * * */ value?: any; /** - * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. + * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. * * * @@ -27675,19 +27675,19 @@ interface IgPercentEditor { buttonType?: string; /** - * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. + * Gets/Sets custom width of the drop-down list in pixels. If the value is equal to 0 or negative, then the width of editor is set as a drop-down width. * */ listWidth?: number; /** - * Gets/Sets the hover/unhover animation duration of a drop-down list item. + * Gets/Sets the hover/unhover animation duration of a drop-down list item. * */ listItemHoverDuration?: number; /** - * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. + * Gets wheather the drop-down list element is attached to the body of the document, or to the editor container element. * If the option is set to false the editor will attach the drop-down list element to the editor container * If the option is set to true the editor will attach its drop-down list to as a child of the body. * Note! This option can not be set runtime. @@ -27696,13 +27696,13 @@ interface IgPercentEditor { dropDownAttachedToBody?: boolean; /** - * Gets/Sets show/hide drop-down list animation duration in milliseconds. + * Gets/Sets show/hide drop-down list animation duration in milliseconds. * */ dropDownAnimationDuration?: number; /** - * Gets the number of the items to be shown at once when the drop-down list get opened. + * Gets the number of the items to be shown at once when the drop-down list get opened. * Notes: * This option is overwritten if the number of list items is less than the set value. In that case the drop-down list displays all the items. * This option can not be set runtime. @@ -27711,13 +27711,13 @@ interface IgPercentEditor { visibleItemsCount?: number; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -27729,25 +27729,25 @@ interface IgPercentEditor { selectionOnFocus?: string; /** - * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed + * Gets/Sets if the editor should only allow values set into the list of items. This validation is done only when the editor is blured, or enter key is pressed * */ isLimitedToListValues?: boolean; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. + * Gets/Sets the drop-down list opening orientation when the list gets open. If the option is set to auto the editor has priority to open the drop-down list bottom. If the space is not enough it tries to open the list top. If the space is not enough in both directions then the list gets opened at the bottom of the editor. * * * Valid values: @@ -27758,7 +27758,7 @@ interface IgPercentEditor { dropDownOrientation?: string; /** - * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. + * Gets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. * Note! In case there are no list items - the editor will reamin readonly * Note! This option can not be set runtime. * @@ -27766,19 +27766,19 @@ interface IgPercentEditor { dropDownOnReadOnly?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -27787,7 +27787,7 @@ interface IgPercentEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -27796,37 +27796,37 @@ interface IgPercentEditor { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -27834,35 +27834,35 @@ interface IgPercentEditor { validatorOptions?: any; /** - * Option for igPercentEditor + * Option for igPercentEditor */ [optionName: string]: any; } interface IgPercentEditorMethods { /** - * Paste text at location of the caret or over the current selection. Best used during editing, as the method will instead set the text as value (modified by the [displayFactor](ui.igpercenteditor#options:displayFactor)) if the editor is not focused. - * Note: the method raises the [textChanged](ui.igpercenteditor#events:textChanged) event. + * Paste text at location of the caret or over the current selection. Best used during editing, as the method will instead set the text as value (modified by the [displayFactor](ui.igpercenteditor#options:displayFactor)) if the editor is not focused. + * Note: the method raises the [textChanged](ui.igpercenteditor#events:textChanged) event. * * @param string The string to be inserted. */ insert(string: string): void; /** - * Gets/Sets a string that is used as the percent symbol shown with the number in the input. The value provided as a param is propagated to the [percentSymbol](ui.igpercenteditor#options:percentSymbol) option and thus has the same priority as the option. + * Gets/Sets a string that is used as the percent symbol shown with the number in the input. The value provided as a param is propagated to the [percentSymbol](ui.igpercenteditor#options:percentSymbol) option and thus has the same priority as the option. * * @param symbol New percent symbol. */ percentSymbol(symbol?: Object): string; /** - * Gets/Sets editor value. + * Gets/Sets editor value. * * @param newValue New editor value. */ value(newValue?: number): number; /** - * Finds index of list item by text that matches with the search parameters. + * Finds index of list item by text that matches with the search parameters. * * @param number The text to search for. */ @@ -27872,31 +27872,31 @@ interface IgPercentEditorMethods { getSelectionEnd(): void; /** - * Increments value in editor according to the parameter. + * Increments value in editor according to the parameter. * * @param delta Increments value. */ spinUp(delta?: number): void; /** - * Decrements value in editor according to the parameter. + * Decrements value in editor according to the parameter. * * @param delta Decrement value. */ spinDown(delta?: number): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexUp(): void; /** - * Moves the hovered index to the item that appears above the current one in the list. + * Moves the hovered index to the item that appears above the current one in the list. */ selectListIndexDown(): void; /** - * Gets current regional. + * Gets current regional. */ getRegionalOption(): string; } @@ -27906,20 +27906,20 @@ interface JQuery { interface IgMaskEditor { /** - * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. + * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets visibility of the clear button. That option can be set only on initialization. + * Gets visibility of the clear button. That option can be set only on initialization. * * clear A button to clear the value is located on the right side of the editor. */ buttonType?: string; /** - * Gets input mask. Mask may include filter-flags and literal characters. + * Gets input mask. Mask may include filter-flags and literal characters. * Literal characters are part of mask which cannot be modified by end user. In order to use a filter-flag as a literal character, the escape "\\" character should be used. * Default is "CCCCCCCCCC" * Note: optional flags/entries affect the value returned by get of the [value](ui.igmaskeditor#methods:value) methods. @@ -27941,7 +27941,7 @@ interface IgMaskEditor { inputMask?: string; /** - * Gets/Sets type of value returned by the get of [value](ui.igmaskeditor#methods:value) method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * Gets/Sets type of value returned by the get of [value](ui.igmaskeditor#methods:value) method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. * * * Valid values: @@ -27955,25 +27955,25 @@ interface IgMaskEditor { dataMode?: string; /** - * Gets character which is used as prompt in edit mode for available entry position. + * Gets character which is used as prompt in edit mode for available entry position. * */ unfilledCharsPrompt?: string; /** - * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Note that this option is visible, only when the [revertIfNotValid](ui.igmaskeditor#options:revertIfNotValid) option is set to false. + * Gets/Sets character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Note that this option is visible, only when the [revertIfNotValid](ui.igmaskeditor#options:revertIfNotValid) option is set to false. * */ padChar?: string; /** - * Gets/Sets character which is used as replacement of not-filled required position in mask when application calls get for the [value](ui.igmaskeditor#methods:value) methods. + * Gets/Sets character which is used as replacement of not-filled required position in mask when application calls get for the [value](ui.igmaskeditor#methods:value) methods. * */ emptyChar?: string; /** - * Gets ability to enter only specific characters in input-field from keyboard and on paste. + * Gets ability to enter only specific characters in input-field from keyboard and on paste. * Notes: * If "excludeKeys" option contains same characters as this option, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -27982,7 +27982,7 @@ interface IgMaskEditor { includeKeys?: string; /** - * Gets ability to prevent entering specific characters from keyboard or on paste. + * Gets ability to prevent entering specific characters from keyboard or on paste. * Notes: * If a character is specified in "includeKeys" option also, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -27991,58 +27991,58 @@ interface IgMaskEditor { excludeKeys?: string; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. + * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. */ spinWrapAround?: boolean; /** - * Sets gets list of items which are used for drop-down list. + * Sets gets list of items which are used for drop-down list. * Items in list can be strings, numbers or objects. The items are directly rendered without casting, or manipulating them. */ listItems?: any[]; /** - * Sets gets custom width of drop-down list in pixels. If value is equal to 0 or negative, then the width of editor is used. + * Sets gets custom width of drop-down list in pixels. If value is equal to 0 or negative, then the width of editor is used. */ listWidth?: number; /** - * Sets the hover/unhover animation duration. + * Sets the hover/unhover animation duration. */ listItemHoverDuration?: number; /** - * Sets the ability to allow values only set into the list items. This validation is done only when the editor is blured, or enter key is pressed + * Sets the ability to allow values only set into the list items. This validation is done only when the editor is blured, or enter key is pressed */ isLimitedToListValues?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownOrientation?: string; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownAttachedToBody?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownAnimationDuration?: number; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownOnReadOnly?: boolean; /** - * + * */ textMode?: any; /** - * Gets/Sets how many items should be shown at once. + * Gets/Sets how many items should be shown at once. * Notes: * That option is overwritten if the number of list items is less than the value. In that case the height of the dropdown is adjusted to the number of items. * Note! This option can not be set runtime. @@ -28050,18 +28050,18 @@ interface IgMaskEditor { visibleItemsCount?: number; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ maxLength?: any; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * */ value?: any; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -28072,13 +28072,13 @@ interface IgMaskEditor { textAlign?: string; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -28090,45 +28090,45 @@ interface IgMaskEditor { selectionOnFocus?: string; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the ability to convert the input characters to upper case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. + * Gets/Sets the ability to convert the input characters to upper case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. * Note! When the option is set at runtime the editor is not changing the current value. * */ toUpper?: boolean; /** - * Gets/Sets the ability to convert the input characters to lower case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. + * Gets/Sets the ability to convert the input characters to lower case (true) or keeps the characters as they are (false). The option has effect only while keyboard entries and paste. * Note! When the option is set at runtime the editor is not changing the current value. * */ toLower?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -28137,7 +28137,7 @@ interface IgMaskEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -28146,44 +28146,44 @@ interface IgMaskEditor { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is false, and editor has no value, then value is set to an empty string. * */ allowNullValue?: boolean; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -28197,7 +28197,7 @@ interface IgMaskEditor { dropDownItemSelected?: DropDownItemSelectedEvent; /** - * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, + * Event which is raised after text in the editor was changed. It can be raised when keyUp event occurs, * when the clear button is clicked or when an item from a list is selected. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. @@ -28207,13 +28207,13 @@ interface IgMaskEditor { textChanged?: TextChangedEvent; /** - * Option for igMaskEditor + * Option for igMaskEditor */ [optionName: string]: any; } interface IgMaskEditorMethods { /** - * Gets/Sets mask editor value. + * Gets/Sets mask editor value. * * @param newValue New mask editor value. */ @@ -28232,45 +28232,45 @@ interface IgMaskEditorMethods { spinDown(): void; /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; /** - * Gets the visible text in the editor. + * Gets the visible text in the editor. */ displayValue(): string; /** - * Returns a reference to the clear button UI element of the editor. + * Returns a reference to the clear button UI element of the editor. */ clearButton(): string; /** - * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. + * Gets the selected text from the editor in edit mode. This can be done on key event like keydown or keyup. This method can be used only when the editor is focused. If you call this method in display mode (The editor input is blured) the returned value will be an empty string. */ getSelectedText(): string; /** - * Gets the start index of the selected text in the editor. + * Gets the start index of the selected text in the editor. */ getSelectionStart(): number; /** - * Gets the end index of the selected text in the editor. + * Gets the end index of the selected text in the editor. */ getSelectionEnd(): number; /** - * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. - * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. + * Inserts the text at the location of the caret or over the current selection. If the editor is focused the method will insert the text over the current selection. If the editor is not focused the method will set the text as value of the editor. + * Note: The method raises [textChanged](ui.igtexteditor#events:textChanged) event. * * @param string The string to be inserted. */ insert(string: string): void; /** - * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. + * Selects the text between start and end indices in the editor. If the parameters are equal, then the method sets location of caret. The method has effect only when the editor has focus. * * @param start Start of the selection. * @param end End of the selection. @@ -28283,28 +28283,28 @@ interface JQuery { interface IgDateEditor { /** - * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. + * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ value?: Object; /** - * Gets the minimum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. + * Gets the minimum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ minValue?: Object; /** - * Gets the maximum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. + * Gets the maximum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ maxValue?: Object; /** - * Gets/Sets format of date while editor has no focus. + * Gets/Sets format of date while editor has no focus. * Value of that option can be set to a specific date pattern or to a flag defined by regional settings. * If value is not set, then the dateInputFormat is used automatically. * If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them. @@ -28346,7 +28346,7 @@ interface IgDateEditor { dateDisplayFormat?: string; /** - * Gets format of date while editor has focus. + * Gets format of date while editor has focus. * Value of that option can be set to explicit date pattern or to a flag defined by regional settings. * If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them. * If option is not set, then the "date" is used automatically. @@ -28377,7 +28377,7 @@ interface IgDateEditor { dateInputFormat?: string; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. * Note: That is used as default. * * @@ -28389,7 +28389,7 @@ interface IgDateEditor { dataMode?: string; /** - * Gets visibility of the spin and clear buttons. That option can be set only on initialization. Combinations like 'spin,clear' are supported too. + * Gets visibility of the spin and clear buttons. That option can be set only on initialization. Combinations like 'spin,clear' are supported too. * * * Valid values: @@ -28399,13 +28399,13 @@ interface IgDateEditor { buttonType?: string; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. * */ spinDelta?: number; /** - * Gets/Sets ability to modify only 1 date field on spin events. + * Gets/Sets ability to modify only 1 date field on spin events. * Value false enables changes of other date fields when incremented or decremented date-field reaches its limits. * Value true modifies only value of one field. * @@ -28413,7 +28413,7 @@ interface IgDateEditor { limitSpinToCurrentField?: boolean; /** - * Gets/Sets formatting of the dates as UTC. + * Gets/Sets formatting of the dates as UTC. * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. * Notes: * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. @@ -28426,7 +28426,7 @@ interface IgDateEditor { enableUTCDates?: boolean; /** - * Gets/Sets year for auto detection of 20th and 21st centuries. + * Gets/Sets year for auto detection of 20th and 21st centuries. * That option is used to automatically fill century when the user entered only 1 or 2 digits into the year field or when the date pattern contains only 1 or 2 year positions, e.g. "yy" or "y". * If user entered value larger than value of this option, then 20th century is used, otherwise the 21st. * @@ -28434,90 +28434,90 @@ interface IgDateEditor { centuryThreshold?: number; /** - * Gets/Set value used to increase/decrease year part of the date, in order to set difference between year in Gregorian calendar and displayed year. + * Gets/Set value used to increase/decrease year part of the date, in order to set difference between year in Gregorian calendar and displayed year. * */ yearShift?: number; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ isLimitedToListValues?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ listItemHoverDuration?: number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ listItems?: any; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ listWidth?: number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ dropDownAnimationDuration?: number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ dropDownAttachedToBody?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ dropDownOnReadOnly?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ inputMask?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ unfilledCharsPrompt?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ padChar?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ emptyChar?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ toUpper?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ toLower?: boolean; /** - * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. + * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets ability to enter only specific characters in input-field from keyboard and on paste. + * Gets ability to enter only specific characters in input-field from keyboard and on paste. * Notes: * If "excludeKeys" option contains same characters as this option, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -28526,7 +28526,7 @@ interface IgDateEditor { includeKeys?: string; /** - * Gets ability to prevent entering specific characters from keyboard or on paste. + * Gets ability to prevent entering specific characters from keyboard or on paste. * Notes: * If a character is specified in "includeKeys" option also, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -28535,22 +28535,22 @@ interface IgDateEditor { excludeKeys?: string; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. + * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. */ spinWrapAround?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownOrientation?: string; /** - * + * */ textMode?: any; /** - * Gets/Sets how many items should be shown at once. + * Gets/Sets how many items should be shown at once. * Notes: * That option is overwritten if the number of list items is less than the value. In that case the height of the dropdown is adjusted to the number of items. * Note! This option can not be set runtime. @@ -28558,12 +28558,12 @@ interface IgDateEditor { visibleItemsCount?: number; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ maxLength?: any; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -28574,13 +28574,13 @@ interface IgDateEditor { textAlign?: string; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -28592,31 +28592,31 @@ interface IgDateEditor { selectionOnFocus?: string; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -28625,7 +28625,7 @@ interface IgDateEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -28634,38 +28634,38 @@ interface IgDateEditor { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is false, and editor has no value, then value is set to an empty string. * */ allowNullValue?: boolean; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -28673,88 +28673,88 @@ interface IgDateEditor { validatorOptions?: any; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownListOpening?: DropDownListOpeningEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownListOpened?: DropDownListOpenedEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownListClosing?: DropDownListClosingEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownListClosed?: DropDownListClosedEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownItemSelecting?: DropDownItemSelectingEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDateEditor + * This event is inherited from a parent widget and it's not triggered in igDateEditor */ dropDownItemSelected?: DropDownItemSelectedEvent; /** - * Option for igDateEditor + * Option for igDateEditor */ [optionName: string]: any; } interface IgDateEditorMethods { /** - * Gets/Sets editor value. + * Gets/Sets editor value. * - * Note! This option doesn't use the displayInputFormat to extract the date + * Note! This option doesn't use the displayInputFormat to extract the date * * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). */ value(newValue?: Object): Object; /** - * Gets selected date. + * Gets selected date. */ getSelectedDate(): Object; /** - * Sets selected date. + * Sets selected date. * * @param date */ selectDate(date: Object): void; /** - * Increases the date or time period, depending on the current cursor position. + * Increases the date or time period, depending on the current cursor position. * * @param delta The increase delta. */ spinUp(delta?: number): void; /** - * Decreases the date or time period, depending on the current cursor position. + * Decreases the date or time period, depending on the current cursor position. * * @param delta The decrease delta. */ spinDown(delta?: number): void; /** - * Returns a reference to the spin up UI element of the editor. + * Returns a reference to the spin up UI element of the editor. */ spinUpButton(): string; /** - * Returns a reference to the spin down UI element of the editor. + * Returns a reference to the spin down UI element of the editor. */ spinDownButton(): string; /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; dropDownButton(): void; @@ -28776,35 +28776,35 @@ interface ItemSelectedEvent { interface ItemSelectedEventUIParam { /** - * Used to obtain reference to igEditor. + * Used to obtain reference to igEditor. */ owner?: any; /** - * Used to obtain reference to the date object which is selected. + * Used to obtain reference to the date object which is selected. */ dateFromPicker?: any; /** - * Used to obtain a referece to the selected html element from the calendar. + * Used to obtain a referece to the selected html element from the calendar. */ item?: any; /** - * Used to obtain a reference to jQuery UI date picker, used as a calendar from the igDatePicker. + * Used to obtain a reference to jQuery UI date picker, used as a calendar from the igDatePicker. */ calendar?: any; } interface IgDatePicker { /** - * Gets/Sets the custom regional settings for the editor. If it is a string, then $.ig.regional[stringValue] is assumed. + * Gets/Sets the custom regional settings for the editor. If it is a string, then $.ig.regional[stringValue] is assumed. * */ regional?: any; /** - * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too. + * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too. * * * Valid values: @@ -28815,66 +28815,66 @@ interface IgDatePicker { buttonType?: string; /** - * Gets/Sets the options supported by the [jquery.ui.datepicker](http://api.jqueryui.com/datepicker/). Only options related to the drop-down calendar are supported. + * Gets/Sets the options supported by the [jquery.ui.datepicker](http://api.jqueryui.com/datepicker/). Only options related to the drop-down calendar are supported. * */ datepickerOptions?: any; /** - * Gets the ability to limit igDatePicker to be used only as s calendar. When set to true the editor input is not editable. + * Gets the ability to limit igDatePicker to be used only as s calendar. When set to true the editor input is not editable. * Note! This option can not be set runtime. * */ dropDownOnReadOnly?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDatePicker + * This option is inherited from a parent widget and it's not applicable for igDatePicker */ dropDownAttachedToBody?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDatePicker + * This option is inherited from a parent widget and it's not applicable for igDatePicker */ isLimitedToListValues?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDatePicker + * This option is inherited from a parent widget and it's not applicable for igDatePicker */ listItemHoverDuration?: number; /** - * This option is inherited from a parent widget and it's not applicable for igDatePicker + * This option is inherited from a parent widget and it's not applicable for igDatePicker */ listItems?: any; /** - * This option is inherited from a parent widget and it's not applicable for igDatePicker + * This option is inherited from a parent widget and it's not applicable for igDatePicker */ listWidth?: number; /** - * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. + * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ value?: Object; /** - * Gets the minimum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. + * Gets the minimum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ minValue?: Object; /** - * Gets the maximum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. + * Gets the maximum value which can be entered in editor by user. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. * */ maxValue?: Object; /** - * Gets/Sets format of date while editor has no focus. + * Gets/Sets format of date while editor has no focus. * Value of that option can be set to a specific date pattern or to a flag defined by regional settings. * If value is not set, then the dateInputFormat is used automatically. * If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them. @@ -28916,7 +28916,7 @@ interface IgDatePicker { dateDisplayFormat?: string; /** - * Gets format of date while editor has focus. + * Gets format of date while editor has focus. * Value of that option can be set to explicit date pattern or to a flag defined by regional settings. * If value is set to explicit date pattern and pattern besides date-flags has explicit characters which match with date-flags or mask-flags, then the "escape" character should be used in front of them. * If option is not set, then the "date" is used automatically. @@ -28947,7 +28947,7 @@ interface IgDatePicker { dateInputFormat?: string; /** - * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. + * Gets/Sets the value type returned by the get of value() method. That also affects functionality of the set value(val) method and the copy/paste operations of browser. * Note: That is used as default. * * @@ -28959,13 +28959,13 @@ interface IgDatePicker { dataMode?: string; /** - * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. + * Gets/Sets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer value is supported only for dataMode double and float. * */ spinDelta?: number; /** - * Gets/Sets ability to modify only 1 date field on spin events. + * Gets/Sets ability to modify only 1 date field on spin events. * Value false enables changes of other date fields when incremented or decremented date-field reaches its limits. * Value true modifies only value of one field. * @@ -28973,7 +28973,7 @@ interface IgDatePicker { limitSpinToCurrentField?: boolean; /** - * Gets/Sets formatting of the dates as UTC. + * Gets/Sets formatting of the dates as UTC. * That option is supported only when dataMode option is 'date' and Date objects are used to get/set value of editor. * Notes: * That option affects only functionality of get/set value method and the Date-value, which was set on initialization. @@ -28986,7 +28986,7 @@ interface IgDatePicker { enableUTCDates?: boolean; /** - * Gets/Sets year for auto detection of 20th and 21st centuries. + * Gets/Sets year for auto detection of 20th and 21st centuries. * That option is used to automatically fill century when the user entered only 1 or 2 digits into the year field or when the date pattern contains only 1 or 2 year positions, e.g. "yy" or "y". * If user entered value larger than value of this option, then 20th century is used, otherwise the 21st. * @@ -28994,54 +28994,54 @@ interface IgDatePicker { centuryThreshold?: number; /** - * Gets/Set value used to increase/decrease year part of the date, in order to set difference between year in Gregorian calendar and displayed year. + * Gets/Set value used to increase/decrease year part of the date, in order to set difference between year in Gregorian calendar and displayed year. * */ yearShift?: number; /** - * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string + * Gets/Sets the representation of null value. In case of default the value for the input is set to null, which makes the input to hold an empty string * */ nullValue?: string|number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ dropDownAnimationDuration?: number; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ inputMask?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ unfilledCharsPrompt?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ padChar?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ emptyChar?: string; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ toUpper?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igDateEditor + * This option is inherited from a parent widget and it's not applicable for igDateEditor */ toLower?: boolean; /** - * Gets ability to enter only specific characters in input-field from keyboard and on paste. + * Gets ability to enter only specific characters in input-field from keyboard and on paste. * Notes: * If "excludeKeys" option contains same characters as this option, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -29050,7 +29050,7 @@ interface IgDatePicker { includeKeys?: string; /** - * Gets ability to prevent entering specific characters from keyboard or on paste. + * Gets ability to prevent entering specific characters from keyboard or on paste. * Notes: * If a character is specified in "includeKeys" option also, then "excludeKeys" has priority. * Note! This option can not be se runtime. @@ -29059,22 +29059,22 @@ interface IgDatePicker { excludeKeys?: string; /** - * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. + * Gets/Sets the ability of the editor to automatically change the hoverd item into the opened dropdown list to its oposide side. */ spinWrapAround?: boolean; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ dropDownOrientation?: string; /** - * + * */ textMode?: any; /** - * Gets/Sets how many items should be shown at once. + * Gets/Sets how many items should be shown at once. * Notes: * That option is overwritten if the number of list items is less than the value. In that case the height of the dropdown is adjusted to the number of items. * Note! This option can not be set runtime. @@ -29082,12 +29082,12 @@ interface IgDatePicker { visibleItemsCount?: number; /** - * This option is inherited from a parent widget and it's not applicable for igMaskEditor + * This option is inherited from a parent widget and it's not applicable for igMaskEditor */ maxLength?: any; /** - * Gets/Sets the horizontal alignment of the text in the editor. + * Gets/Sets the horizontal alignment of the text in the editor. * * * Valid values: @@ -29098,13 +29098,13 @@ interface IgDatePicker { textAlign?: string; /** - * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. + * Gets/Sets the text which appears in the editor when it has no focus and the "value" is null or empty string. * */ placeHolder?: string; /** - * Gets/Sets the action when the editor gets focused. The default value is selectAll. + * Gets/Sets the action when the editor gets focused. The default value is selectAll. * * * Valid values: @@ -29116,31 +29116,31 @@ interface IgDatePicker { selectionOnFocus?: string; /** - * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. + * Gets/Sets if the editor should revert it's value to the previously valid value in case the value on blur, or enter key is not valid. If the opiton is set to false, editor calls clear functionality. * */ revertIfNotValid?: boolean; /** - * Gets/Sets if the editor should prevent form submition when enter key is pressed. + * Gets/Sets if the editor should prevent form submition when enter key is pressed. * */ preventSubmitOnEnter?: boolean; /** - * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. + * Gets/Sets the strings used for the localization of the component. This includes button titles, error messages etc. Value of the object should contain pairs or key:value members. Note: any sub-option of locale can appear within the main option of igEditor. In this case those values within main options will have highest priority and override corresponding value in locale. * */ locale?: any; /** - * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. + * Disables/Enables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. * */ suppressNotifications?: boolean; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -29149,7 +29149,7 @@ interface IgDatePicker { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -29158,38 +29158,38 @@ interface IgDatePicker { height?: string|number; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets whether the editor value can become null. + * Gets/Sets whether the editor value can become null. * If that option is false, and editor has no value, then value is set to an empty string. * */ allowNullValue?: boolean; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. + * Gets/Sets the readonly attribute for the input. If set to true the input is readonly, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is submitted. * */ readOnly?: boolean; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -29197,7 +29197,7 @@ interface IgDatePicker { validatorOptions?: any; /** - * Event which is raised when the drop down is opening. + * Event which is raised when the drop down is opening. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -29206,7 +29206,7 @@ interface IgDatePicker { dropDownListOpening?: DropDownListOpeningEvent; /** - * Event which is raised after the drop down is opened. + * Event which is raised after the drop down is opened. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -29215,17 +29215,17 @@ interface IgDatePicker { dropDownListOpened?: DropDownListOpenedEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDatePicker + * This event is inherited from a parent widget and it's not triggered in igDatePicker */ dropDownListClosing?: DropDownListClosingEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDatePicker + * This event is inherited from a parent widget and it's not triggered in igDatePicker */ dropDownItemSelecting?: DropDownItemSelectingEvent; /** - * Event which is raised after the drop down (calendar) is closed. + * Event which is raised after the drop down (calendar) is closed. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.editorInput to obtain reference to the editable input @@ -29234,12 +29234,12 @@ interface IgDatePicker { dropDownListClosed?: DropDownListClosedEvent; /** - * This event is inherited from a parent widget and it's not triggered in igDatePicker + * This event is inherited from a parent widget and it's not triggered in igDatePicker */ dropDownItemSelected?: DropDownItemSelectedEvent; /** - * Event which is raised after a date selection in the calendar. + * Event which is raised after a date selection in the calendar. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.dateFromPicker to obtain reference to the date object which is selected. @@ -29249,13 +29249,13 @@ interface IgDatePicker { itemSelected?: ItemSelectedEvent; /** - * Option for igDatePicker + * Option for igDatePicker */ [optionName: string]: any; } interface IgDatePickerMethods { /** - * Returns a reference to the jQuery calendar used as a picker selector + * Returns a reference to the jQuery calendar used as a picker selector */ getCalendar(): string; dropDownContainer(): void; @@ -29264,77 +29264,77 @@ interface IgDatePickerMethods { selectedListIndex(): void; /** - * Shows the drop down list. + * Shows the drop down list. */ showDropDown(): void; /** - * Hides the drop down list. + * Hides the drop down list. */ hideDropDown(): void; /** - * Returns a reference to the calendar button UI element of the editor. + * Returns a reference to the calendar button UI element of the editor. */ dropDownButton(): string; /** - * Returns the visibility state of the calendar. + * Returns the visibility state of the calendar. */ dropDownVisible(): boolean; /** - * Destroys the widget + * Destroys the widget */ destroy(): void; /** - * Gets/Sets editor value. + * Gets/Sets editor value. * - * Note! This option doesn't use the displayInputFormat to extract the date + * Note! This option doesn't use the displayInputFormat to extract the date * * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). */ value(newValue?: Object): Object; /** - * Gets selected date. + * Gets selected date. */ getSelectedDate(): Object; /** - * Sets selected date. + * Sets selected date. * * @param date */ selectDate(date: Object): void; /** - * Increases the date or time period, depending on the current cursor position. + * Increases the date or time period, depending on the current cursor position. * * @param delta The increase delta. */ spinUp(delta?: number): void; /** - * Decreases the date or time period, depending on the current cursor position. + * Decreases the date or time period, depending on the current cursor position. * * @param delta The decrease delta. */ spinDown(delta?: number): void; /** - * Returns a reference to the spin up UI element of the editor. + * Returns a reference to the spin up UI element of the editor. */ spinUpButton(): string; /** - * Returns a reference to the spin down UI element of the editor. + * Returns a reference to the spin down UI element of the editor. */ spinDownButton(): string; /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; } @@ -29344,13 +29344,13 @@ interface JQuery { interface IgCheckboxEditor { /** - * Gets/Sets whether the checkbox is checked. + * Gets/Sets whether the checkbox is checked. * */ checked?: boolean; /** - * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. + * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. * * * @@ -29363,20 +29363,20 @@ interface IgCheckboxEditor { size?: string; /** - * Gets/Sets a custom class on the checkbox. Custom image can be used this way. + * Gets/Sets a custom class on the checkbox. Custom image can be used this way. * The following jQuery classes can be used in addition http://api.jqueryui.com/theming/icons/ * */ iconClass?: string; /** - * Gets/Sets tabIndex attribute for the editor input. + * Gets/Sets tabIndex attribute for the editor input. * */ tabIndex?: number; /** - * Gets/Sets the readonly attribute. Does not allow editing. Disables changing the checkbox state as an interaction, but it still can be changed programmatically. On submit the current value is sent into the request. + * Gets/Sets the readonly attribute. Does not allow editing. Disables changing the checkbox state as an interaction, but it still can be changed programmatically. On submit the current value is sent into the request. * */ readOnly?: boolean; @@ -29384,7 +29384,7 @@ interface IgCheckboxEditor { nullValue?: any; /** - * Gets/Sets the width of the control. + * Gets/Sets the width of the control. * * * Valid values: @@ -29393,7 +29393,7 @@ interface IgCheckboxEditor { width?: string|number; /** - * Gets/Sets the height of the control. + * Gets/Sets the height of the control. * * * Valid values: @@ -29402,25 +29402,25 @@ interface IgCheckboxEditor { height?: string|number; /** - * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. + * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. * */ value?: any; /** - * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. + * Gets/Sets the name attribute of the value input. This input is used to sent the value to the server. In case the target element is input and it has name attribute, but the developer has set the inputName option, so this option overwrites the value input and removes the attribute from the element. * */ inputName?: string; /** - * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. + * Gets/Sets the disabled attribute for the input. If set to true the input is disabled, and all buttons and interactions are disabled. On submitting the form the editor belongs to, the value is not submitted. * */ disabled?: boolean; /** - * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. + * Gets/Sets options supported by the [igValidator](ui.igvalidator#options) widget. * Note: Validation rules of [igValidator](ui.igvalidator#options), such as min and max value/length are applied separately triggering errors, * while the corresponding options of the editor prevent values violating the defined rules from being entered. * @@ -29428,7 +29428,7 @@ interface IgCheckboxEditor { validatorOptions?: any; /** - * Event which is raised before value in editor was changed. + * Event which is raised before value in editor was changed. * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. @@ -29442,7 +29442,7 @@ interface IgCheckboxEditor { valueChanging?: ValueChangingEvent; /** - * Event which is raised after value in editor was changed. + * Event which is raised after value in editor was changed. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.newValue to obtain the new value. @@ -29453,7 +29453,7 @@ interface IgCheckboxEditor { valueChanged?: ValueChangedEvent; /** - * Event which is raised before rendering of the editor completes. + * Event which is raised before rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -29461,7 +29461,7 @@ interface IgCheckboxEditor { rendering?: RenderingEvent; /** - * Event which is raised after rendering of the editor completes. + * Event which is raised after rendering of the editor completes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the editor performing rendering. * Use ui.element to get a reference to the editor element. @@ -29469,7 +29469,7 @@ interface IgCheckboxEditor { rendered?: RenderedEvent; /** - * Event which is raised on mousedown event. + * Event which is raised on mousedown event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29478,7 +29478,7 @@ interface IgCheckboxEditor { mousedown?: MousedownEvent; /** - * Event which is raised on mouseup event. + * Event which is raised on mouseup event. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29487,7 +29487,7 @@ interface IgCheckboxEditor { mouseup?: MouseupEvent; /** - * Event which is raised on mousemove at any part of editor including drop-down list. + * Event which is raised on mousemove at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29496,7 +29496,7 @@ interface IgCheckboxEditor { mousemove?: MousemoveEvent; /** - * Event which is raised on mouseover at any part of editor including drop-down list. + * Event which is raised on mouseover at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29505,7 +29505,7 @@ interface IgCheckboxEditor { mouseover?: MouseoverEvent; /** - * Event which is raised on mouseleave at any part of editor including drop-down list. + * Event which is raised on mouseleave at any part of editor including drop-down list. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29514,7 +29514,7 @@ interface IgCheckboxEditor { mouseout?: MouseoutEvent; /** - * Event which is raised when input field of editor loses focus. + * Event which is raised when input field of editor loses focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29523,7 +29523,7 @@ interface IgCheckboxEditor { blur?: BlurEvent; /** - * Event which is raised when input field of editor gets focus. + * Event which is raised when input field of editor gets focus. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igEditor. * Use ui.element to obtain a reference to the event target. @@ -29532,7 +29532,7 @@ interface IgCheckboxEditor { focus?: FocusEvent; /** - * Event which is raised on keydown event. + * Event which is raised on keydown event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -29542,7 +29542,7 @@ interface IgCheckboxEditor { keydown?: KeydownEvent; /** - * Event which is raised on keypress event. + * Event which is raised on keypress event. * Return false in order to cancel key action. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. @@ -29552,7 +29552,7 @@ interface IgCheckboxEditor { keypress?: KeypressEvent; /** - * Event which is raised on keyup event. + * Event which is raised on keyup event. * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igEditor. @@ -29561,83 +29561,83 @@ interface IgCheckboxEditor { keyup?: KeyupEvent; /** - * Option for igCheckboxEditor + * Option for igCheckboxEditor */ [optionName: string]: any; } interface IgCheckboxEditorMethods { /** - * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. + * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ isValid(): boolean; /** - * Gets/Sets Current checked state/Value of the igCheckboxEditor that will be submitted by the HTML form. - * 1. If the [value](ui.igcheckboxeditor#options:value) option IS NOT defined, then 'value' method will match the checked state of the editor. - * This option is used when the checkbox is intended to operate as a Boolean editor. In that case the return type is bool. - * 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined, then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted. - * To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked"); + * Gets/Sets Current checked state/Value of the igCheckboxEditor that will be submitted by the HTML form. + * 1. If the [value](ui.igcheckboxeditor#options:value) option IS NOT defined, then 'value' method will match the checked state of the editor. + * This option is used when the checkbox is intended to operate as a Boolean editor. In that case the return type is bool. + * 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined, then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted. + * To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked"); * * @param newValue */ value(newValue: Object): string; /** - * Toggles the state of the checkbox. + * Toggles the state of the checkbox. */ toggle(): void; /** - * Gets/Sets name attribute applied to the editor element. + * Gets/Sets name attribute applied to the editor element. * * @param newValue The new input name. */ inputName(newValue?: string): string; /** - * Gets the input element of the editor. + * Gets the input element of the editor. */ field(): string; /** - * Gets a reference to the jQuery element that wraps the editor. + * Gets a reference to the jQuery element that wraps the editor. */ editorContainer(): string; /** - * Gets whether the editor has focus. + * Gets whether the editor has focus. */ hasFocus(): boolean; /** - * Sets focus to the editor after the specified delay. + * Sets focus to the editor after the specified delay. * * @param delay The delay before focusing the editor. */ setFocus(delay?: number): void; /** - * Hides the editor. + * Hides the editor. */ hide(): void; /** - * Shows the editor. + * Shows the editor. */ show(): void; /** - * Gets a reference to [igValidator](ui.igvalidator) used by the editor. + * Gets a reference to [igValidator](ui.igvalidator) used by the editor. */ validator(): Object; /** - * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). + * Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator). */ validate(): boolean; /** - * Destroys the widget + * Destroys the widget */ destroy(): void; } @@ -36667,29 +36667,29 @@ interface SliceClickedEvent { interface SliceClickedEventUIParam { /** - * Used to obtain reference to igFunnelChart. + * Used to obtain reference to igFunnelChart. */ owner?: any; /** - * Used to obtain index of clicked slice. + * Used to obtain index of clicked slice. */ index?: any; /** - * Used to obtain reference to clicked slice item. + * Used to obtain reference to clicked slice item. */ item?: any; /** - * Used to check if slice became selected. + * Used to check if slice became selected. */ selected?: any; } interface IgFunnelChart { /** - * Gets or sets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled. + * Gets or sets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled. * Value should provide 4 numeric values in range from 0 to 1 separated by space character. * The first number defines upper-x position, second: upper-y, third: lower-x, fourth: lower-y. * The null or invalid value will reset internal default, which is "0.5 0 0.5 1". @@ -36699,7 +36699,7 @@ interface IgFunnelChart { bezierPoints?: string; /** - * Gets or sets the Legend for the chart. + * Gets or sets the Legend for the chart. * The value of that option can be a string with the id of existing html element. That element should be empty and it will be used to create igChartLegend widget. * If element was not found, then new DIV element is created and inserted into parent after chart element. * Value of that option can be an object with member "element", which contains the id of legend-element. @@ -36713,41 +36713,41 @@ interface IgFunnelChart { legend?: any; /** - * Gets or sets the value member path for the funnel chart. + * Gets or sets the value member path for the funnel chart. */ valueMemberPath?: string; /** - * Gets or sets the Brushes property. + * Gets or sets the Brushes property. * The brushes property defines the palette from which automatically assigned brushes are selected. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ brushes?: any; /** - * Gets or sets the Outlines property. + * Gets or sets the Outlines property. * The Outlines property defines the palette from which automatically assigned Outlines are selected. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ outlines?: any; /** - * Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take. + * Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take. */ bottomEdgeWidth?: number; /** - * Gets or sets the InnerLabel mapping property for the current series object. + * Gets or sets the InnerLabel mapping property for the current series object. */ innerLabelMemberPath?: string; /** - * Gets or sets the OuterLabel mapping property for the current series object. + * Gets or sets the OuterLabel mapping property for the current series object. */ outerLabelMemberPath?: string; /** - * Gets or sets whether the inner labels are visible. + * Gets or sets whether the inner labels are visible. * * Valid values: * "visible" @@ -36756,7 +36756,7 @@ interface IgFunnelChart { innerLabelVisibility?: string; /** - * Gets or sets whether the outer labels are visible. + * Gets or sets whether the outer labels are visible. * * Valid values: * "visible" @@ -36765,7 +36765,7 @@ interface IgFunnelChart { outerLabelVisibility?: string; /** - * Gets or sets which side of the chart the outer labels should appear. + * Gets or sets which side of the chart the outer labels should appear. * * Valid values: * "left" The labels will be displayed to the left of the chart. @@ -36774,7 +36774,7 @@ interface IgFunnelChart { outerLabelAlignment?: string; /** - * Gets or sets the how the heights of the funnel slices should be configured. + * Gets or sets the how the heights of the funnel slices should be configured. * * Valid values: * "uniform" The slice heights should be uniform. @@ -36783,54 +36783,54 @@ interface IgFunnelChart { funnelSliceDisplay?: string; /** - * Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart. + * Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart. */ formatInnerLabel?: any; /** - * Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart. + * Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to igFunnelChart. */ formatOuterLabel?: any; /** - * Gets or sets how long the animations should take to run. + * Gets or sets how long the animations should take to run. */ transitionDuration?: number; /** - * Gets or sets if the funnel should be rendered inverted. + * Gets or sets if the funnel should be rendered inverted. */ isInverted?: boolean; /** - * Gets or sets whether to use a Bezier curve to define the funnel. + * Gets or sets whether to use a Bezier curve to define the funnel. */ useBezierCurve?: boolean; /** - * Gets or sets whether to allow slices to be selected. + * Gets or sets whether to allow slices to be selected. */ allowSliceSelection?: boolean; /** - * Gets or sets whether to use the unselected style on unselected slices. + * Gets or sets whether to use the unselected style on unselected slices. */ useUnselectedStyle?: boolean; /** - * Gets or sets the style to use for selected slices. + * Gets or sets the style to use for selected slices. * That can be used to set stroke (outline color), fill (background color) and opacity. */ selectedSliceStyle?: any; /** - * Gets or sets the style to use for unselected slices. + * Gets or sets the style to use for unselected slices. * That can be used to set stroke (outline color), fill (background color) and opacity. */ unselectedSliceStyle?: any; /** - * Gets or sets the LegendItemBadgeTemplate to use for the legend items. + * Gets or sets the LegendItemBadgeTemplate to use for the legend items. * The provided object should have properties called render and optionally measure. * These are functions which will be called that will be called to handle the user specified custom rendering. * measure will be passed an object that looks like this: @@ -36855,22 +36855,22 @@ interface IgFunnelChart { legendItemBadgeTemplate?: any; /** - * Gets or sets whether to use the outer labels to identify the legend items. + * Gets or sets whether to use the outer labels to identify the legend items. */ useOuterLabelsForLegend?: boolean; /** - * Gets or sets the text style for inner labels + * Gets or sets the text style for inner labels */ textStyle?: string; /** - * Gets or sets the text style for outer labels + * Gets or sets the text style for outer labels */ outerLabelTextStyle?: string; /** - * Gets or sets the thickness of outline around slices. + * Gets or sets the thickness of outline around slices. */ outlineThickness?: number; pixelScalingRatio?: number; @@ -36878,55 +36878,55 @@ interface IgFunnelChart { textColor?: any; /** - * The width of the chart. + * The width of the chart. */ width?: number; /** - * The height of the chart. + * The height of the chart. */ height?: number; /** - * Gets sets template for tooltip associated with chart item. + * Gets sets template for tooltip associated with chart item. * Example: "Value: $(ValueMemberPathInDataSource)" */ tooltipTemplate?: string; /** - * Gets sets maximum number of displayed records in chart. + * Gets sets maximum number of displayed records in chart. */ maxRecCount?: number; /** - * Gets sets a valid data source. + * Gets sets a valid data source. * That can be instance of array or primitives, array of objects, instance of $.ig.DataSource, or any other data accepted by $.ig.DataSource. * Note: if it is set to string and "dataSourceType" option is not set, then $.ig.JSONPDataSource is used. */ dataSource?: any; /** - * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property + * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property */ dataSourceType?: string; /** - * Gets sets url which is used for sending JSON on request for remote data. + * Gets sets url which is used for sending JSON on request for remote data. */ dataSourceUrl?: string; /** - * See $.ig.DataSource. property in the response specifying the total number of records on the server. + * See $.ig.DataSource. property in the response specifying the total number of records on the server. */ responseTotalRecCountKey?: string; /** - * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. + * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. */ responseDataKey?: string; /** - * Event which is raised when a slice is clicked. + * Event which is raised when a slice is clicked. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to igFunnelChart. * Use ui.index to obtain index of clicked slice. @@ -36936,7 +36936,7 @@ interface IgFunnelChart { sliceClicked?: SliceClickedEvent; /** - * Event which is raised before data binding. + * Event which is raised before data binding. * Return false in order to cancel data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -36945,7 +36945,7 @@ interface IgFunnelChart { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding. + * Event which is raised after data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. * Use ui.data to obtain reference to array actual data which is displayed by chart. @@ -36954,7 +36954,7 @@ interface IgFunnelChart { dataBound?: DataBoundEvent; /** - * Event which is raised before tooltip is updated. + * Event which is raised before tooltip is updated. * Return false in order to cancel updating and hide tooltip. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -36967,7 +36967,7 @@ interface IgFunnelChart { updateTooltip?: UpdateTooltipEvent; /** - * Event which is raised before tooltip is hidden. + * Event which is raised before tooltip is hidden. * Return false in order to cancel hiding and keep tooltip visible. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -36977,13 +36977,13 @@ interface IgFunnelChart { hideTooltip?: HideTooltipEvent; /** - * Option for igFunnelChart + * Option for igFunnelChart */ [optionName: string]: any; } interface IgFunnelChartMethods { /** - * Gets array of selected slice items. + * Gets array of selected slice items. * * @param selection Array or selected slice items. * @return array|object If parameter is undefined, then array of selected items is returned. Otherwise, it returns reference to igFunnelChart. @@ -36991,7 +36991,7 @@ interface IgFunnelChartMethods { selectedSliceItems(selection?: any[]): any[]; /** - * Gets sets array of indexes of selected slices. + * Gets sets array of indexes of selected slices. * * @param selection Array or selected slice indexes. * @return array|object If parameter is undefined, then array of selected indexes is returned. Otherwise, it returns reference to igFunnelChart. @@ -36999,14 +36999,14 @@ interface IgFunnelChartMethods { selectedSliceIndexes(selection?: any[]): any[]; /** - * Checks if slice is selected. + * Checks if slice is selected. * * @param slice Index of slice or reference to slice-data-item. */ isSelected(slice: Object): boolean; /** - * Toggles selected state of slice. + * Toggles selected state of slice. * * @param slice Index of slice or reference to slice-data-item. */ @@ -37014,38 +37014,38 @@ interface IgFunnelChartMethods { exportVisualData(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; /** - * Find index of item within actual data used by chart. + * Find index of item within actual data used by chart. * * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** - * Get item within actual data used by chart. That is similar to this.getData()[ index ]. + * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * * @param index Index of data item. */ getDataItem(index: Object): Object; /** - * Get reference of actual data used by chart. + * Get reference of actual data used by chart. */ getData(): any[]; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -37053,14 +37053,14 @@ interface IgFunnelChartMethods { insertItem(item: Object, index: number): Object; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -37068,7 +37068,7 @@ interface IgFunnelChartMethods { setItem(index: number, item: Object): Object; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -37078,16 +37078,16 @@ interface IgFunnelChartMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -37096,8 +37096,8 @@ interface IgFunnelChartMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -37106,12 +37106,12 @@ interface IgFunnelChartMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Get reference to chart object. + * Get reference to chart object. */ chart(): Object; /** - * Binds data to the chart + * Binds data to the chart */ dataBind(): void; } @@ -37789,17 +37789,17 @@ interface JQuery { } interface IgPopoverHeaderTemplate { /** - * Controls whether the popover renders a functional close button + * Controls whether the popover renders a functional close button */ closeButton?: boolean; /** - * Sets the content for the popover header + * Sets the content for the popover header */ title?: string; /** - * Option for IgPopoverHeaderTemplate + * Option for IgPopoverHeaderTemplate */ [optionName: string]: any; } @@ -37810,22 +37810,22 @@ interface ShowingEvent { interface ShowingEventUIParam { /** - * Used to get the element the popover will show for. + * Used to get the element the popover will show for. */ element?: any; /** - * Used to get or set the content to be shown as a string. + * Used to get or set the content to be shown as a string. */ content?: any; /** - * Used to get the popover element showing. + * Used to get the popover element showing. */ popover?: any; /** - * Used to get reference to the igPopover widget + * Used to get reference to the igPopover widget */ owner?: any; } @@ -37836,22 +37836,22 @@ interface ShownEvent { interface ShownEventUIParam { /** - * Used to get the element the popover showed for. + * Used to get the element the popover showed for. */ element?: any; /** - * Used to get the content that was shown as a string. + * Used to get the content that was shown as a string. */ content?: any; /** - * Used to get the popover element shown. + * Used to get the popover element shown. */ popover?: any; /** - * Used to get reference to the igPopover widget + * Used to get reference to the igPopover widget */ owner?: any; } @@ -37862,22 +37862,22 @@ interface HidingEvent { interface HidingEventUIParam { /** - * Used to get the element the popover will hide for. + * Used to get the element the popover will hide for. */ element?: any; /** - * Used to get the current content displayed in the popover as a string. + * Used to get the current content displayed in the popover as a string. */ content?: any; /** - * Used to get the popover element hiding. + * Used to get the popover element hiding. */ popover?: any; /** - * Used to get reference to the igPopover widget + * Used to get reference to the igPopover widget */ owner?: any; } @@ -37888,22 +37888,22 @@ interface HiddenEvent { interface HiddenEventUIParam { /** - * Used to get the element the popover is hidden for. + * Used to get the element the popover is hidden for. */ element?: any; /** - * Used to get the content displayed in the popover as a string. + * Used to get the content displayed in the popover as a string. */ content?: any; /** - * Used to get the popover element hidden. + * Used to get the popover element hidden. */ popover?: any; /** - * Used to get reference to the igPopover widget + * Used to get reference to the igPopover widget */ owner?: any; } @@ -37915,7 +37915,7 @@ interface IgGridFeatureChooserPopover { containment?: any; /** - * controls the direction in which the control shows relative to the target element + * controls the direction in which the control shows relative to the target element * * Valid values: * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left @@ -37927,7 +37927,7 @@ interface IgGridFeatureChooserPopover { direction?: string; /** - * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area + * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * * Valid values: * "auto" lets the control choose a position depending on available space with the following priority balanced > end > start @@ -37938,37 +37938,37 @@ interface IgGridFeatureChooserPopover { position?: string; /** - * defines width for the popover. leave null for auto. + * defines width for the popover. leave null for auto. */ width?: number|string; /** - * defines height for the popover. leave null for auto + * defines height for the popover. leave null for auto */ height?: number|string; /** - * defines width the popover won't go under the value even if no specific one is set. + * defines width the popover won't go under the value even if no specific one is set. */ minWidth?: number|string; /** - * defines width the popover won't exceed even if no specific one is set. + * defines width the popover won't exceed even if no specific one is set. */ maxWidth?: number|string; /** - * defines height the popover won't exceed even if no specific one is set. + * defines height the popover won't exceed even if no specific one is set. */ maxHeight?: number|string; /** - * Sets the time popover fades in and out when showing/hiding + * Sets the time popover fades in and out when showing/hiding */ animationDuration?: number; /** - * sets the content for the popover container. If left null the content will be get from the target. + * sets the content for the popover container. If left null the content will be get from the target. * * Valid values: * "string" String content of the popover container @@ -37977,17 +37977,17 @@ interface IgGridFeatureChooserPopover { contentTemplate?: string|Function; /** - * Selectors indicating which items should show popovers. The predefined value is [title]. Customize if you're using something other then the title attribute for the popover content, or if you need a different selector for event delegation. When changing this option, you likely need to also change the contentTemplate option + * Selectors indicating which items should show popovers. The predefined value is [title]. Customize if you're using something other then the title attribute for the popover content, or if you need a different selector for event delegation. When changing this option, you likely need to also change the contentTemplate option */ selectors?: string; /** - * Sets the content for the popover header + * Sets the content for the popover header */ headerTemplate?: IgPopoverHeaderTemplate; /** - * sets the event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" + * sets the event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" * * Valid values: * "mouseenter" the popover is shown on mouse enter in the target element @@ -37997,7 +37997,7 @@ interface IgGridFeatureChooserPopover { showOn?: string; /** - * Controls where the popover DOM should be attached to. + * Controls where the popover DOM should be attached to. * * * Valid values: @@ -38007,7 +38007,7 @@ interface IgGridFeatureChooserPopover { appendTo?: string|Object; /** - * Event fired before popover is shown. + * Event fired before popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will show for. * Use ui.content to get or set the content to be shown as a string. @@ -38017,7 +38017,7 @@ interface IgGridFeatureChooserPopover { showing?: ShowingEvent; /** - * Event fired after popover is shown. + * Event fired after popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover showed for. * Use ui.content to get the content that was shown as a string. @@ -38027,7 +38027,7 @@ interface IgGridFeatureChooserPopover { shown?: ShownEvent; /** - * Event fired before popover is hidden. + * Event fired before popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will hide for. * Use ui.content to get the current content displayed in the popover as a string. @@ -38037,7 +38037,7 @@ interface IgGridFeatureChooserPopover { hiding?: HidingEvent; /** - * Event fired after popover is hidden. + * Event fired after popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover is hidden for. * Use ui.content to get the content displayed in the popover as a string. @@ -38047,7 +38047,7 @@ interface IgGridFeatureChooserPopover { hidden?: HiddenEvent; /** - * Option for igGridFeatureChooserPopover + * Option for igGridFeatureChooserPopover */ [optionName: string]: any; } @@ -38057,17 +38057,17 @@ interface IgGridFeatureChooserPopoverMethods { destroy(): void; /** - * Returns the ID of the element the popover is attached to + * Returns the ID of the element the popover is attached to */ id(): string; /** - * Returns the container for the popover contents + * Returns the container for the popover contents */ container(): Object; /** - * Shows the popover for the specified target + * Shows the popover for the specified target * * @param trg The element to show popover for. * @param content The string to set for the popover to show. @@ -38075,34 +38075,34 @@ interface IgGridFeatureChooserPopoverMethods { show(trg?: Element, content?: string): void; /** - * Hides the popover for the specified target + * Hides the popover for the specified target */ hide(): void; /** - * Gets the currently set content for the popover container + * Gets the currently set content for the popover container */ getContent(): string; /** - * Sets the content for the popover container + * Sets the content for the popover container * * @param newCnt The popover content to set. */ setContent(newCnt: string): void; /** - * Gets the popover current target + * Gets the popover current target */ target(): Object; /** - * Gets the current coordinates of the popover + * Gets the current coordinates of the popover */ getCoordinates(): Object; /** - * Sets the popover to specific coordinates. + * Sets the popover to specific coordinates. * * @param pos The popover coordinates in pixels. */ @@ -38173,7 +38173,7 @@ interface IgGridFeatureChooser { featureToggled?: FeatureToggledEvent; /** - * Option for igGridFeatureChooser + * Option for igGridFeatureChooser */ [optionName: string]: any; } @@ -38181,28 +38181,28 @@ interface IgGridFeatureChooserMethods { shouldShowFeatureIcon(key: Object): void; /** - * Show feature chooser dialog by the specified column key + * Show feature chooser dialog by the specified column key * * @param columnKey Key of the column that should be shown. */ showDropDown(columnKey: string): void; /** - * Hide feature chooser dialog by column key + * Hide feature chooser dialog by column key * * @param columnKey Key of the column that should be hidden. */ hideDropDown(columnKey: string): void; /** - * Get jQuery representation of the div holding dropdown for the specified columnKey + * Get jQuery representation of the div holding dropdown for the specified columnKey * * @param columnKey Key of the column */ getDropDownByColumnKey(columnKey: string): void; /** - * Show/hide feature chooser dialog by column key + * Show/hide feature chooser dialog by column key * * @param columnKey Key of the column that should be shown/hidden. */ @@ -38597,56 +38597,56 @@ interface JQuery { } interface IgGridGroupByGroupedColumn { /** - * Key of the column that's grouped + * Key of the column that's grouped */ key?: string; /** - * sort order - ascending or descending + * sort order - ascending or descending * */ dir?: any; /** - * Key of the columnLayout, if the grid is hierarchical + * Key of the columnLayout, if the grid is hierarchical * */ layout?: string; /** - * [column](ui.iggrid#options:columns) object for the column that is grouped + * [column](ui.iggrid#options:columns) object for the column that is grouped * */ col?: any; /** - * Option for IgGridGroupByGroupedColumn + * Option for IgGridGroupByGroupedColumn */ [optionName: string]: any; } interface IgGridGroupBySummarySettings { /** - * Specifies the delimiter for multiple summaries. + * Specifies the delimiter for multiple summaries. * */ multiSummaryDelimiter?: string; /** - * Format of the summary value. By default, two digits are shown after the decimal place. Checkout [Formatting Dates, Numbers and Strings](http://www.igniteui.com/help/formatting-dates-numbers-and-strings) for details on the valid formatting specifiers. + * Format of the summary value. By default, two digits are shown after the decimal place. Checkout [Formatting Dates, Numbers and Strings](http://www.igniteui.com/help/formatting-dates-numbers-and-strings) for details on the valid formatting specifiers. * */ summaryFormat?: string; /** - * Option for IgGridGroupBySummarySettings + * Option for IgGridGroupBySummarySettings */ [optionName: string]: any; } interface IgGridGroupByColumnSettingsSummaries { /** - * the summary function key + * the summary function key * * * Valid values: @@ -38660,13 +38660,13 @@ interface IgGridGroupByColumnSettingsSummaries { summaryFunction?: string; /** - * Specifies the summary text that will be shown before the value + * Specifies the summary text that will be shown before the value * */ text?: string; /** - * Specifies a custom summary function, which is called for each group, it should return the custom summary result.It takes as argument object with the following signature: {dataRecords: [], array: [], key: "", allGroupData: []} where, + * Specifies a custom summary function, which is called for each group, it should return the custom summary result.It takes as argument object with the following signature: {dataRecords: [], array: [], key: "", allGroupData: []} where, * dataRecords - array of grouped (for the [data view](ig.datasource#methods:dataView)) data records, * array - array of cell values for the specified column, * key - key of the grouped column, @@ -38681,26 +38681,26 @@ interface IgGridGroupByColumnSettingsSummaries { customSummary?: string|Function; /** - * Option for IgGridGroupByColumnSettingsSummaries + * Option for IgGridGroupByColumnSettingsSummaries */ [optionName: string]: any; } interface IgGridGroupByColumnSettings { /** - * Enables/disables grouping a column from the UI. By default all columns can be grouped. + * Enables/disables grouping a column from the UI. By default all columns can be grouped. * */ allowGrouping?: boolean; /** - * Specifies the initial column grouped state. + * Specifies the initial column grouped state. * */ isGroupBy?: boolean; /** - * Reference/name of a function (string or function) used for custom comparison. + * Reference/name of a function (string or function) used for custom comparison. * The function accepts the following arguments: * val1 - the first value to compare * val2 - the second value to compare @@ -38718,12 +38718,12 @@ interface IgGridGroupByColumnSettings { compareFunc?: string|Function; /** - * Specifies a custom group by function, which accepts the column setting, the first and the second value to compare and returns bool. This option is deprecated - please use option [compareFunc](ui.iggridgroupby#options:columnSettings.compareFunc) instead. + * Specifies a custom group by function, which accepts the column setting, the first and the second value to compare and returns bool. This option is deprecated - please use option [compareFunc](ui.iggridgroupby#options:columnSettings.compareFunc) instead. */ groupComparerFunction?: Function; /** - * Reference/name of a function (string or function) which will be used for formatting the cell values. The function should accept a value from the grouped column and return the new formatted value in the label of the row. + * Reference/name of a function (string or function) which will be used for formatting the cell values. The function should accept a value from the grouped column and return the new formatted value in the label of the row. * * * Valid values: @@ -38733,19 +38733,19 @@ interface IgGridGroupByColumnSettings { groupLabelFormatter?: string|Function; /** - * Specifies the sort order - ascending or descending when the column is initially grouped ([isGroupBy](ui.iggridgroupby#options:columnSettings.isGroupBy) = true). + * Specifies the sort order - ascending or descending when the column is initially grouped ([isGroupBy](ui.iggridgroupby#options:columnSettings.isGroupBy) = true). * */ dir?: any; /** - * A list of aggregation functions to calculate on the column values for each group. When not specified the default aggregate function is "count". + * A list of aggregation functions to calculate on the column values for each group. When not specified the default aggregate function is "count". * */ summaries?: IgGridGroupByColumnSettingsSummaries; /** - * Option for IgGridGroupByColumnSettings + * Option for IgGridGroupByColumnSettings */ [optionName: string]: any; } @@ -38756,37 +38756,37 @@ interface GroupedColumnsChangingEvent { interface GroupedColumnsChangingEventUIParam { /** - * Used to access the GroupBy widget object + * Used to access the GroupBy widget object */ owner?: any; /** - * Used to get a reference to the current groupedColumns. + * Used to get a reference to the current groupedColumns. */ groupedColumns?: any; /** - * Used to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) + * Used to get an object of the new grouped columns that should be applied.(it is set ONLY if called from modal dialog) */ newGroupedColumns?: any; /** - * Used to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) + * Used to get a reference to the current column"s key that"s being grouped(not set if called from modal dialog) */ key?: any; /** - * Used to get a reference to the current layout object, if any(not set if called from modal dialog) + * Used to get a reference to the current layout object, if any(not set if called from modal dialog) */ layout?: any; /** - * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) + * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) */ grid?: any; /** - * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup + * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ triggeredBy?: any; } @@ -38797,32 +38797,32 @@ interface GroupedColumnsChangedEvent { interface GroupedColumnsChangedEventUIParam { /** - * Used to access the GroupBy widget object + * Used to access the GroupBy widget object */ owner?: any; /** - * Used to get a reference to the current groupedColumns + * Used to get a reference to the current groupedColumns */ groupedColumns?: any; /** - * Used to get a reference to the current column"s key that"s being grouped + * Used to get a reference to the current column"s key that"s being grouped */ key?: any; /** - * Used to get a reference to the current layout object, if any + * Used to get a reference to the current layout object, if any */ layout?: any; /** - * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) + * Used to get a reference to the current child grid element, in case it's an hierarchical grid(not set if called from modal dialog) */ grid?: any; /** - * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup + * Used to get which user interaction triggers the event - possible options are dragAndDrop|modalDialog|sortStateChanged|removeButton|regroup */ triggeredBy?: any; } @@ -38833,22 +38833,22 @@ interface ModalDialogMovingEvent { interface ModalDialogMovingEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ modalDialogElement?: any; /** - * Used to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. + * Used to get the original position of the GroupBy Dialog div as { top, left } object, relative to the page. */ originalPosition?: any; /** - * Used to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. + * Used to get the current position of the GroupBy Dialog div as { top, left } object, relative to the page. */ position?: any; } @@ -38859,12 +38859,12 @@ interface ModalDialogClosingEvent { interface ModalDialogClosingEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38875,12 +38875,12 @@ interface ModalDialogClosedEvent { interface ModalDialogClosedEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38891,12 +38891,12 @@ interface ModalDialogOpeningEvent { interface ModalDialogOpeningEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38907,12 +38907,12 @@ interface ModalDialogOpenedEvent { interface ModalDialogOpenedEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38923,12 +38923,12 @@ interface ModalDialogContentsRenderingEvent { interface ModalDialogContentsRenderingEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38939,12 +38939,12 @@ interface ModalDialogContentsRenderedEvent { interface ModalDialogContentsRenderedEventUIParam { /** - * Used to get the reference to the igGridGroupBy widget. + * Used to get the reference to the igGridGroupBy widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -38955,27 +38955,27 @@ interface ModalDialogButtonApplyClickEvent { interface ModalDialogButtonApplyClickEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; /** - * Used to get the array of grouped columns + * Used to get the array of grouped columns */ groupedColumns?: any; /** - * Used to get array of column layouts + * Used to get array of column layouts */ groupedColumnLayouts?: any; /** - * Used to get array of sorted columns + * Used to get array of sorted columns */ sortingExpr?: any; } @@ -38986,12 +38986,12 @@ interface ModalDialogButtonResetClickEvent { interface ModalDialogButtonResetClickEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; } @@ -39002,17 +39002,17 @@ interface ModalDialogGroupingColumnEvent { interface ModalDialogGroupingColumnEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get the key of the column to be grouped. + * Used to get the key of the column to be grouped. */ key?: any; /** - * Used to get the layout of the columns + * Used to get the layout of the columns */ layout?: any; } @@ -39023,22 +39023,22 @@ interface ModalDialogGroupColumnEvent { interface ModalDialogGroupColumnEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get the key of the column to be grouped. + * Used to get the key of the column to be grouped. */ key?: any; /** - * Used to get a reference to the current groupedColumns + * Used to get a reference to the current groupedColumns */ groupedColumns?: any; /** - * Used to get the layout of the columns + * Used to get the layout of the columns */ layout?: any; } @@ -39049,17 +39049,17 @@ interface ModalDialogUngroupingColumnEvent { interface ModalDialogUngroupingColumnEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get the key of the column to be grouped. + * Used to get the key of the column to be grouped. */ key?: any; /** - * Used to get the layout of the columns + * Used to get the layout of the columns */ layout?: any; } @@ -39070,22 +39070,22 @@ interface ModalDialogUngroupColumnEvent { interface ModalDialogUngroupColumnEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get a reference to the current groupedColumns + * Used to get a reference to the current groupedColumns */ groupedColumns?: any; /** - * Used to get the key of the column to be grouped. + * Used to get the key of the column to be grouped. */ key?: any; /** - * Used to get the layout of the columns + * Used to get the layout of the columns */ layout?: any; } @@ -39096,29 +39096,29 @@ interface ModalDialogSortGroupedColumnEvent { interface ModalDialogSortGroupedColumnEventUIParam { /** - * Used to get the reference to the igGridGroupby widget. + * Used to get the reference to the igGridGroupby widget. */ owner?: any; /** - * Used to get the key of the column to be grouped. + * Used to get the key of the column to be grouped. */ key?: any; /** - * Used to get the layout of the columns + * Used to get the layout of the columns */ layout?: any; /** - * Used to get whether column should be sorted ascending or descending + * Used to get whether column should be sorted ascending or descending */ isAsc?: any; } interface IgGridGroupBy { /** - * Sets the place in the grid where the GroupBy area will be + * Sets the place in the grid where the GroupBy area will be * * * Valid values: @@ -39129,49 +39129,49 @@ interface IgGridGroupBy { groupByAreaVisibility?: string; /** - * Specifies if after grouping, the grouped rows will be initially expanded or collapsed. + * Specifies if after grouping, the grouped rows will be initially expanded or collapsed. * */ initialExpand?: boolean; /** - * Text that will be shown in the GroupBy area when there are no grouped columns + * Text that will be shown in the GroupBy area when there are no grouped columns * */ emptyGroupByAreaContent?: string; /** - * Text of the link that opens the [GroupBy Dialog](http://www.igniteui.com/help/iggrid-group-by-dialog-overview). + * Text of the link that opens the [GroupBy Dialog](http://www.igniteui.com/help/iggrid-group-by-dialog-overview). * */ emptyGroupByAreaContentSelectColumns?: string; /** - * Specifies if grouped rows will have an expander image that will allow end users to expand and collapse them. This option can be set only at initialization. + * Specifies if grouped rows will have an expander image that will allow end users to expand and collapse them. This option can be set only at initialization. * */ expansionIndicatorVisibility?: boolean; /** - * By default, the column width for the header is taken. If this is specified it's used for all headers. + * By default, the column width for the header is taken. If this is specified it's used for all headers. * */ groupByLabelWidth?: number; /** - * Specifies the opacity of the drag markup, while a column header is being dragged. The value must be between 0 and 1. + * Specifies the opacity of the drag markup, while a column header is being dragged. The value must be between 0 and 1. * */ labelDragHelperOpacity?: number; /** - * Specifies the indentation for a grouped row. If several columns are grouped, the total indentation will grow + * Specifies the indentation for a grouped row. If several columns are grouped, the total indentation will grow * */ indentation?: number; /** - * default sort order - ascending or descending + * default sort order - ascending or descending * * * Valid values: @@ -39181,25 +39181,25 @@ interface IgGridGroupBy { defaultSortingDirection?: string; /** - * Returns the list of currently grouped columns. The option is read-only and cannot be set at initialization or at runtime. + * Returns the list of currently grouped columns. The option is read-only and cannot be set at initialization or at runtime. * */ groupedColumns?: IgGridGroupByGroupedColumn[]; /** - * Specifies a key to get group by data from the remote response. + * Specifies a key to get group by data from the remote response. * */ resultResponseKey?: string; /** - * Template for the grouped row's text. Variables available for the template are ${key}, ${val} and ${count}. + * Template for the grouped row's text. Variables available for the template are ${key}, ${val} and ${count}. * */ groupedRowTextTemplate?: string; /** - * Specifies whether the GroupBy operation takes place locally on client-side or remotely on server-side. + * Specifies whether the GroupBy operation takes place locally on client-side or remotely on server-side. * * * Valid values: @@ -39209,139 +39209,139 @@ interface IgGridGroupBy { type?: string; /** - * URL param name which specifies a GroupBy [expression](ig.datasource#options:settings.sorting.expressions). When groupByUrlKey, [groupByUrlKeyAscValue](ui.iggridgroupby#options:groupByUrlKeyAscValue) and [groupByUrlKeyDescValue](ui.iggridgroupby#options:groupByUrlKeyDescValue) are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. + * URL param name which specifies a GroupBy [expression](ig.datasource#options:settings.sorting.expressions). When groupByUrlKey, [groupByUrlKeyAscValue](ui.iggridgroupby#options:groupByUrlKeyAscValue) and [groupByUrlKeyDescValue](ui.iggridgroupby#options:groupByUrlKeyDescValue) are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. * */ groupByUrlKey?: string; /** - * URL param value denoting ascending grouping. When [groupByUrlKey](ui.iggridgroupby#options:groupByUrlKey), groupByUrlKeyAscValue and [groupByUrlKeyDescValue](ui.iggridgroupby#options:groupByUrlKeyDescValue) are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. + * URL param value denoting ascending grouping. When [groupByUrlKey](ui.iggridgroupby#options:groupByUrlKey), groupByUrlKeyAscValue and [groupByUrlKeyDescValue](ui.iggridgroupby#options:groupByUrlKeyDescValue) are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. * */ groupByUrlKeyAscValue?: string; /** - * URL param value denoting descending grouping. When [groupByUrlKey](ui.iggridgroupby#options:groupByUrlKey), [groupByUrlKeyAscValue](ui.iggridgroupby#options:groupByUrlKeyAscValue) and groupByUrlKeyDescValue are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. + * URL param value denoting descending grouping. When [groupByUrlKey](ui.iggridgroupby#options:groupByUrlKey), [groupByUrlKeyAscValue](ui.iggridgroupby#options:groupByUrlKeyAscValue) and groupByUrlKeyDescValue are set the request looks like: ?()= (Example: ?groupby(col1)=asc). Otherwise the OData conventions for sorting params are used. * */ groupByUrlKeyDescValue?: string; /** - * Specifies the settings for GroupBy summaries. + * Specifies the settings for GroupBy summaries. * */ summarySettings?: IgGridGroupBySummarySettings; /** - * Configures individual column settings. + * Configures individual column settings. * */ columnSettings?: IgGridGroupByColumnSettings; /** - * Specifies the expand indicator tooltip for grouped rows + * Specifies the expand indicator tooltip for grouped rows * */ expandTooltip?: string; /** - * Specifies the collapse indicator tooltip for grouped rows + * Specifies the collapse indicator tooltip for grouped rows * */ collapseTooltip?: string; /** - * Specifies the tooltip for the remove button + * Specifies the tooltip for the remove button * */ removeButtonTooltip?: string; /** - * Enables/disables immediate column grouping/ungrouping. When false operation is delayed until after "Apply" button is clicked by the user. + * Enables/disables immediate column grouping/ungrouping. When false operation is delayed until after "Apply" button is clicked by the user. * */ modalDialogGroupByOnClick?: boolean; /** - * Specifies the text of GroupBy button in the GroupBy Dialog + * Specifies the text of GroupBy button in the GroupBy Dialog * */ modalDialogGroupByButtonText?: string; /** - * Specifies caption for each descending sorted column in GroupBy Dialog + * Specifies caption for each descending sorted column in GroupBy Dialog * */ modalDialogCaptionButtonDesc?: string; /** - * Specifies caption for each ascending sorted column in GroupBy Dialog + * Specifies caption for each ascending sorted column in GroupBy Dialog * */ modalDialogCaptionButtonAsc?: string; /** - * Specifies caption button ungroup in GroupBy Dialog + * Specifies caption button ungroup in GroupBy Dialog * */ modalDialogCaptionButtonUngroup?: string; /** - * Specifies caption text for the GroupBy Dialog + * Specifies caption text for the GroupBy Dialog * */ modalDialogCaptionText?: string; /** - * Specifies label for layouts dropdown in the GroupBy Dialog + * Specifies label for layouts dropdown in the GroupBy Dialog * */ modalDialogDropDownLabel?: string; /** - * Specifies name of the root layout which is shown layouts tree dialog + * Specifies name of the root layout which is shown layouts tree dialog * */ modalDialogRootLevelHierarchicalGrid?: string; /** - * Specifies caption of layouts dropdown button in the GroupBy Dialog + * Specifies caption of layouts dropdown button in the GroupBy Dialog * */ modalDialogDropDownButtonCaption?: string; /** - * Specifies label for "Clear all" button in the GroupBy Dialog + * Specifies label for "Clear all" button in the GroupBy Dialog * */ modalDialogClearAllButtonLabel?: string; /** - * Specifies caption for the hyperlink which opens the GroupBy Dialog + * Specifies caption for the hyperlink which opens the GroupBy Dialog * */ emptyGroupByAreaContentSelectColumnsCaption?: string; /** - * Specifies width of layouts dropdown in the GroupBy Dialog + * Specifies width of layouts dropdown in the GroupBy Dialog * */ modalDialogDropDownWidth?: number; /** - * Specifies width of layouts dropdown in the GroupBy Dialog + * Specifies width of layouts dropdown in the GroupBy Dialog * */ modalDialogDropDownAreaWidth?: number; /** - * Specifies time in milliseconds for animation duration to show/hide modal dialog + * Specifies time in milliseconds for animation duration to show/hide modal dialog * */ modalDialogAnimationDuration?: number; /** - * Specifies width of the GroupBy Dialog + * Specifies width of the GroupBy Dialog * * * Valid values: @@ -39351,7 +39351,7 @@ interface IgGridGroupBy { modalDialogWidth?: string|number; /** - * Specifies height of the GroupBy Dialog + * Specifies height of the GroupBy Dialog * * * Valid values: @@ -39361,31 +39361,31 @@ interface IgGridGroupBy { modalDialogHeight?: string|number; /** - * Specifies text of button which apply changes in modal dialog + * Specifies text of button which apply changes in modal dialog * */ modalDialogButtonApplyText?: string; /** - * Specifies text of button which cancel changes in the GroupBy Dialog + * Specifies text of button which cancel changes in the GroupBy Dialog * */ modalDialogButtonCancelText?: string; /** - * Format grouped column using the formatter set in [igGrid.columns.formatter](ui.iggrid#options:columns.formatter) or [igGrid.columns.format](ui.iggrid#options:columns.format). + * Format grouped column using the formatter set in [igGrid.columns.formatter](ui.iggrid#options:columns.formatter) or [igGrid.columns.format](ui.iggrid#options:columns.format). * */ useGridColumnFormatter?: boolean; /** - * Enables / disables GroupBy persistence between states. Checkout the [GroupBy Persistence](http://www.igniteui.com/help/iggrid-groupby-overview#groupBy-persistence) topic for details. + * Enables / disables GroupBy persistence between states. Checkout the [GroupBy Persistence](http://www.igniteui.com/help/iggrid-groupby-overview#groupBy-persistence) topic for details. * */ persist?: boolean; /** - * Controls containment behavior for the GroupBy Dialog. + * Controls containment behavior for the GroupBy Dialog. * * * Valid values: @@ -39395,18 +39395,18 @@ interface IgGridGroupBy { groupByDialogContainment?: string; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. Checkout the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic for details. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. Checkout the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic for details. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event which is fired when the grouped columns collection is about to change. This event is fired even when button OK is clicked from the modal dialog(after event modalDialogButtonApplyClick is fired) + * Event which is fired when the grouped columns collection is about to change. This event is fired even when button OK is clicked from the modal dialog(after event modalDialogButtonApplyClick is fired) * use args.owner in order to access the GroupBy widget object * use args.owner.grid to access the grid widget option * use args.groupedColumns to get a reference to the current groupedColumns. @@ -39419,7 +39419,7 @@ interface IgGridGroupBy { groupedColumnsChanging?: GroupedColumnsChangingEvent; /** - * Event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from GroupBy modal dialog but key, layout and grid are not set + * Event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from GroupBy modal dialog but key, layout and grid are not set * use args.owner in order to access the GroupBy widget object * use args.owner.grid to access the grid widget option * use args.groupedColumns to get a reference to the current groupedColumns @@ -39431,7 +39431,7 @@ interface IgGridGroupBy { groupedColumnsChanged?: GroupedColumnsChangedEvent; /** - * Event fired every time the GroupBy Dialog changes its position. + * Event fired every time the GroupBy Dialog changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39442,7 +39442,7 @@ interface IgGridGroupBy { modalDialogMoving?: ModalDialogMovingEvent; /** - * Event fired before the modal dialog is closed. + * Event fired before the modal dialog is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39451,7 +39451,7 @@ interface IgGridGroupBy { modalDialogClosing?: ModalDialogClosingEvent; /** - * Event fired after the modal dialog has been closed. + * Event fired after the modal dialog has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39460,7 +39460,7 @@ interface IgGridGroupBy { modalDialogClosed?: ModalDialogClosedEvent; /** - * Event fired before the modal dialog is opened. + * Event fired before the modal dialog is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39469,7 +39469,7 @@ interface IgGridGroupBy { modalDialogOpening?: ModalDialogOpeningEvent; /** - * Event fired after the modal dialog is already opened. + * Event fired after the modal dialog is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39478,7 +39478,7 @@ interface IgGridGroupBy { modalDialogOpened?: ModalDialogOpenedEvent; /** - * Event fired before the contents of the modal dialog are rendered. + * Event fired before the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39487,7 +39487,7 @@ interface IgGridGroupBy { modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** - * Event fired after the contents of the modal dialog are rendered. + * Event fired after the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupBy widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39496,7 +39496,7 @@ interface IgGridGroupBy { modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** - * Event fired when the button is Apply is clicked. + * Event fired when the button is Apply is clicked. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39508,7 +39508,7 @@ interface IgGridGroupBy { modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** - * Event fired when reset button is clicked. + * Event fired when reset button is clicked. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39517,7 +39517,7 @@ interface IgGridGroupBy { modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; /** - * Event fired when column in modal dialog is clicked to be grouped. + * Event fired when column in modal dialog is clicked to be grouped. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39527,7 +39527,7 @@ interface IgGridGroupBy { modalDialogGroupingColumn?: ModalDialogGroupingColumnEvent; /** - * Event fired when column in modal dialog is clicked to be grouped. + * Event fired when column in modal dialog is clicked to be grouped. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39538,7 +39538,7 @@ interface IgGridGroupBy { modalDialogGroupColumn?: ModalDialogGroupColumnEvent; /** - * Event fired when column in modal dialog is clicked to be ungrouped. + * Event fired when column in modal dialog is clicked to be ungrouped. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39548,7 +39548,7 @@ interface IgGridGroupBy { modalDialogUngroupingColumn?: ModalDialogUngroupingColumnEvent; /** - * Event fired when column in modal dialog is clicked to be ungrouped. + * Event fired when column in modal dialog is clicked to be ungrouped. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39559,7 +39559,7 @@ interface IgGridGroupBy { modalDialogUngroupColumn?: ModalDialogUngroupColumnEvent; /** - * Event fired when column in modal dialog is sorted. + * Event fired when column in modal dialog is sorted. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridGroupby widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -39570,38 +39570,38 @@ interface IgGridGroupBy { modalDialogSortGroupedColumn?: ModalDialogSortGroupedColumnEvent; /** - * Option for igGridGroupBy + * Option for igGridGroupBy */ [optionName: string]: any; } interface IgGridGroupByMethods { /** - * Open groupby modal dialog + * Open groupby modal dialog */ openGroupByDialog(): void; /** - * Close groupby modal dialog + * Close groupby modal dialog */ closeGroupByDialog(): void; /** - * Render groupby modal dialog and its content + * Render groupby modal dialog and its content */ renderGroupByModalDialog(): void; /** - * Open layouts dropdown + * Open layouts dropdown */ openDropDown(): void; /** - * Close layouts dropdown + * Close layouts dropdown */ closeDropDown(): void; /** - * Check whether column with specified key and layout is grouped + * Check whether column with specified key and layout is grouped * * @param key key of the column * @param layout layout name @@ -39609,7 +39609,7 @@ interface IgGridGroupByMethods { checkColumnIsGrouped(key: string, layout: string): void; /** - * Get grouped data by value for the specific column. NOTE: Before calling this function the data(that is passed as an argument) should be sorted by colKey. + * Get grouped data by value for the specific column. NOTE: Before calling this function the data(that is passed as an argument) should be sorted by colKey. * * @param data data (sorted by colKey) that is used to get the records from. * @param colKey key of the column for which grouping will be applied. @@ -39618,12 +39618,12 @@ interface IgGridGroupByMethods { getGroupedData(data: any[], colKey: string, idval?: string): any[]; /** - * Adds a column to the group by columns list, executes the group by operation and updates the view. + * Adds a column to the group by columns list, executes the group by operation and updates the view. */ groupByColumns(): Object; /** - * Groups by a column + * Groups by a column * * @param key Column Key - group by the column with the specified key * @param layout layout is an optional parameter. if set it means the grouped column is not in the root level but is a child layout column @@ -39632,7 +39632,7 @@ interface IgGridGroupByMethods { groupByColumn(key: string, layout?: string, sortingDirection?: Object): void; /** - * Removes the specified column from the group by columns list, executes the group by operation and updates the view. + * Removes the specified column from the group by columns list, executes the group by operation and updates the view. * * @param key Column Key - ungroup by the column with the specified key * @param layout Layout is an optional parameter. If set it means the grouped column is not in the root level but is a child layout column. @@ -39640,26 +39640,26 @@ interface IgGridGroupByMethods { ungroupByColumn(key: string, layout?: string): void; /** - * Expand group row with specified id + * Expand group row with specified id * * @param rowId data-id attribute of the group row in the DOM */ expand(rowId: string): void; /** - * Expand group row with specified id + * Expand group row with specified id * * @param rowId data-id attribute of the group row in the DOM */ collapse(rowId: string): void; /** - * Clears the group by columns list and updates the view. + * Clears the group by columns list and updates the view. */ ungroupAll(): void; /** - * Destroys the group by feature object. + * Destroys the group by feature object. */ destroy(): void; } @@ -40664,31 +40664,31 @@ interface JQuery { } interface IgGridHidingColumnSetting { /** - * Column key. this is a required property in every column setting if columnIndex is not set. + * Column key. this is a required property in every column setting if columnIndex is not set. * */ columnKey?: string; /** - * Column index. Can be used in place of column key. the preferred way of populating a column setting is to always use the column keys as identifiers. + * Column index. Can be used in place of column key. the preferred way of populating a column setting is to always use the column keys as identifiers. * */ columnIndex?: number; /** - * Allows the column to be hidden. + * Allows the column to be hidden. * */ allowHiding?: boolean; /** - * Sets the initial visibility of the column. + * Sets the initial visibility of the column. * */ hidden?: boolean; /** - * Option for IgGridHidingColumnSetting + * Option for IgGridHidingColumnSetting */ [optionName: string]: any; } @@ -40699,17 +40699,17 @@ interface ColumnHidingEvent { interface ColumnHidingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get the hidden column index. Has a value only if the column's key is a number. + * Used to get the hidden column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the hidden column key. Has a value only if the column's key is a string. + * Used to get the hidden column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -40720,7 +40720,7 @@ interface ColumnHidingRefusedEvent { interface ColumnHidingRefusedEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; columnKeys?: any; @@ -40732,7 +40732,7 @@ interface ColumnShowingRefusedEvent { interface ColumnShowingRefusedEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; columnKeys?: any; @@ -40744,12 +40744,12 @@ interface MultiColumnHidingEvent { interface MultiColumnHidingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. + * Used to get array of the hidden column keys. In case when click on Reset button in column chooser then this is an array of column keys. */ columnKeys?: any; } @@ -40760,17 +40760,17 @@ interface ColumnHiddenEvent { interface ColumnHiddenEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get the hidden column index. Has a value only if the column's key is a number. + * Used to get the hidden column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the hidden column key. Has a value only if the column's key is a string. + * Used to get the hidden column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -40781,17 +40781,17 @@ interface ColumnShowingEvent { interface ColumnShowingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get the shown column index. + * Used to get the shown column index. */ columnIndex?: any; /** - * Used to get the shown column key. + * Used to get the shown column key. */ columnKey?: any; } @@ -40802,17 +40802,17 @@ interface ColumnShownEvent { interface ColumnShownEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get the shown column index. + * Used to get the shown column index. */ columnIndex?: any; /** - * Used to get the shown column key. + * Used to get the shown column key. */ columnKey?: any; } @@ -40823,12 +40823,12 @@ interface ColumnChooserOpeningEvent { interface ColumnChooserOpeningEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40839,12 +40839,12 @@ interface ColumnChooserOpenedEvent { interface ColumnChooserOpenedEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40855,22 +40855,22 @@ interface ColumnChooserMovingEvent { interface ColumnChooserMovingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; /** - * Used to get the original position of the column chooser div as { top, left } object, relative to the page. + * Used to get the original position of the column chooser div as { top, left } object, relative to the page. */ originalPosition?: any; /** - * Used to get the current position of the column chooser div as { top, left } object, relative to the page. + * Used to get the current position of the column chooser div as { top, left } object, relative to the page. */ position?: any; } @@ -40881,12 +40881,12 @@ interface ColumnChooserClosingEvent { interface ColumnChooserClosingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40897,12 +40897,12 @@ interface ColumnChooserClosedEvent { interface ColumnChooserClosedEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40913,12 +40913,12 @@ interface ColumnChooserContentsRenderingEvent { interface ColumnChooserContentsRenderingEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40929,12 +40929,12 @@ interface ColumnChooserContentsRenderedEvent { interface ColumnChooserContentsRenderedEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } @@ -40945,22 +40945,22 @@ interface ColumnChooserButtonApplyClickEvent { interface ColumnChooserButtonApplyClickEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; /** - * Used to get array of columns identifiers which should be shown + * Used to get array of columns identifiers which should be shown */ columnsToShow?: any; /** - * Used to get array of columns identifiers which should be hidden + * Used to get array of columns identifiers which should be hidden */ columnsToHide?: any; } @@ -40971,31 +40971,31 @@ interface ColumnChooserButtonResetClickEvent { interface ColumnChooserButtonResetClickEventUIParam { /** - * Used to get the reference to the GridHiding widget. + * Used to get the reference to the GridHiding widget. */ owner?: any; /** - * Used to get a reference to the Column Chooser element. This is a jQuery object. + * Used to get a reference to the Column Chooser element. This is a jQuery object. */ columnChooserElement?: any; } interface IgGridHiding { /** - * A list of column settings that specifies hiding options on a per column basis. + * A list of column settings that specifies hiding options on a per column basis. * */ columnSettings?: IgGridHidingColumnSetting[]; /** - * The width in pixels of the hidden column indicator in the header. + * The width in pixels of the hidden column indicator in the header. * */ hiddenColumnIndicatorHeaderWidth?: number; /** - * Controls containment behavior. + * Controls containment behavior. * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area @@ -41003,103 +41003,103 @@ interface IgGridHiding { columnChooserContainment?: string; /** - * The default column chooser width. + * The default column chooser width. * */ columnChooserWidth?: string; /** - * The default column chooser height. + * The default column chooser height. * */ columnChooserHeight?: string; /** - * The duration of the dropdown animation in milliseconds. + * The duration of the dropdown animation in milliseconds. * */ dropDownAnimationDuration?: number; /** - * The caption of the column chooser dialog. + * The caption of the column chooser dialog. * */ columnChooserCaptionText?: string; /** - * The text used in the drop down tools menu(Feature Chooser) to launch the column chooser dialog. + * The text used in the drop down tools menu(Feature Chooser) to launch the column chooser dialog. * */ columnChooserDisplayText?: string; /** - * The text displayed in the tooltip of the hidden column indicator. + * The text displayed in the tooltip of the hidden column indicator. * */ hiddenColumnIndicatorTooltipText?: string; /** - * The text used in the drop down tools menu(Feature Chooser) to hide a column. + * The text used in the drop down tools menu(Feature Chooser) to hide a column. * */ columnHideText?: string; /** - * The text used in the column chooser to show column + * The text used in the column chooser to show column * */ columnChooserShowText?: string; /** - * The text used in the column chooser to hide column + * The text used in the column chooser to hide column * */ columnChooserHideText?: string; /** - * Specifies on click show/hide directly to be shown/hidden columns. If columnChooserHideOnClick is false then Apply and Cancel Buttons are shown on the bottom of modal dialog. Columns are Shown/Hidden after the Apply button is clicked + * Specifies on click show/hide directly to be shown/hidden columns. If columnChooserHideOnClick is false then Apply and Cancel Buttons are shown on the bottom of modal dialog. Columns are Shown/Hidden after the Apply button is clicked * */ columnChooserHideOnClick?: boolean; /** - * Text label for reset button. + * Text label for reset button. * */ columnChooserResetButtonLabel?: string; /** - * Specifies time of milliseconds for animation duration to show/hide modal dialog + * Specifies time of milliseconds for animation duration to show/hide modal dialog * */ columnChooserAnimationDuration?: number; /** - * Specifies text of button which apply changes in modal dialog + * Specifies text of button which apply changes in modal dialog * */ columnChooserButtonApplyText?: string; /** - * Specifies text of button which cancel changes in modal dialog + * Specifies text of button which cancel changes in modal dialog * */ columnChooserButtonCancelText?: string; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before a hiding operation is executed. + * Event fired before a hiding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41109,7 +41109,7 @@ interface IgGridHiding { columnHiding?: ColumnHidingEvent; /** - * Event fired when trying to hide all columns in fixed or unfixed area. + * Event fired when trying to hide all columns in fixed or unfixed area. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41118,7 +41118,7 @@ interface IgGridHiding { columnHidingRefused?: ColumnHidingRefusedEvent; /** - * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. + * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41127,7 +41127,7 @@ interface IgGridHiding { columnShowingRefused?: ColumnShowingRefusedEvent; /** - * Event fired before a hiding operation is executed. + * Event fired before a hiding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41136,7 +41136,7 @@ interface IgGridHiding { multiColumnHiding?: MultiColumnHidingEvent; /** - * Event fired after the hiding has been executed and results are rendered. + * Event fired after the hiding has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41146,7 +41146,7 @@ interface IgGridHiding { columnHidden?: ColumnHiddenEvent; /** - * Event fired before a showing operation is executed. + * Event fired before a showing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41156,7 +41156,7 @@ interface IgGridHiding { columnShowing?: ColumnShowingEvent; /** - * Event fired after the showing has been executed and results are rendered. + * Event fired after the showing has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41166,7 +41166,7 @@ interface IgGridHiding { columnShown?: ColumnShownEvent; /** - * Event fired before the column chooser is opened. + * Event fired before the column chooser is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41175,7 +41175,7 @@ interface IgGridHiding { columnChooserOpening?: ColumnChooserOpeningEvent; /** - * Event fired after the column chooser is already opened. + * Event fired after the column chooser is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41184,7 +41184,7 @@ interface IgGridHiding { columnChooserOpened?: ColumnChooserOpenedEvent; /** - * Event fired every time the column chooser changes its position. + * Event fired every time the column chooser changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41195,7 +41195,7 @@ interface IgGridHiding { columnChooserMoving?: ColumnChooserMovingEvent; /** - * Event fired before the column chooser is closed. + * Event fired before the column chooser is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41204,7 +41204,7 @@ interface IgGridHiding { columnChooserClosing?: ColumnChooserClosingEvent; /** - * Event fired after the column chooser has been closed. + * Event fired after the column chooser has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41213,7 +41213,7 @@ interface IgGridHiding { columnChooserClosed?: ColumnChooserClosedEvent; /** - * Event fired before the contents of the column chooser are rendered. + * Event fired before the contents of the column chooser are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41222,7 +41222,7 @@ interface IgGridHiding { columnChooserContentsRendering?: ColumnChooserContentsRenderingEvent; /** - * Event fired after the contents of the column chooser are rendered. + * Event fired after the contents of the column chooser are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41231,7 +41231,7 @@ interface IgGridHiding { columnChooserContentsRendered?: ColumnChooserContentsRenderedEvent; /** - * Event fired when button Apply in column chooser is clicked + * Event fired when button Apply in column chooser is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41242,7 +41242,7 @@ interface IgGridHiding { columnChooserButtonApplyClick?: ColumnChooserButtonApplyClickEvent; /** - * Event fired when button Reset in column chooser is clicked + * Event fired when button Reset in column chooser is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -41251,29 +41251,29 @@ interface IgGridHiding { columnChooserButtonResetClick?: ColumnChooserButtonResetClickEvent; /** - * Option for igGridHiding + * Option for igGridHiding */ [optionName: string]: any; } interface IgGridHidingMethods { /** - * Destroys the hiding widget + * Destroys the hiding widget */ destroy(): void; /** - * Shows the Column Chooser dialog. If it is visible the method does nothing. + * Shows the Column Chooser dialog. If it is visible the method does nothing. */ showColumnChooser(): void; /** - * Hides the Column Chooser dialog. If it is not visible the method does nothing. + * Hides the Column Chooser dialog. If it is not visible the method does nothing. */ hideColumnChooser(): void; /** - * Shows a hidden column. If the column is not hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Shows a hidden column. If the column is not hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. @@ -41282,8 +41282,8 @@ interface IgGridHidingMethods { showColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; /** - * Hides a visible column. If the column is hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Hides a visible column. If the column is hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. @@ -41292,8 +41292,8 @@ interface IgGridHidingMethods { hideColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; /** - * Hides visible columns specified by the array. If the column is hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Hides visible columns specified by the array. If the column is hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are hidden(optional) @@ -41301,8 +41301,8 @@ interface IgGridHidingMethods { hideMultiColumns(columns: any[], callback?: Function): void; /** - * Show visible columns specified by the array. If the column is shown the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Show visible columns specified by the array. If the column is shown the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are shown(optional) @@ -41310,22 +41310,22 @@ interface IgGridHidingMethods { showMultiColumns(columns: any[], callback?: Function): void; /** - * Gets whether the reset button in the column chooser dialog is to be rendered or not. + * Gets whether the reset button in the column chooser dialog is to be rendered or not. */ isToRenderButtonReset(): void; /** - * Reset hidden/shown column to initial state of dialog(when it is opened) + * Reset hidden/shown column to initial state of dialog(when it is opened) */ resetHidingColumnChooser(): void; /** - * Renders the Reset button in the Column Chooser dialog. + * Renders the Reset button in the Column Chooser dialog. */ renderColumnChooserResetButton(): void; /** - * Remove Reset button in column chooser modal dialog + * Remove Reset button in column chooser modal dialog */ removeColumnChooserResetButton(): void; } @@ -41959,22 +41959,22 @@ interface JQuery { } interface IgHierarchicalGridColumnLayout { /** - * Specifies the columnLayout key. This is the property that holds the data records for the current column layout. + * Specifies the columnLayout key. This is the property that holds the data records for the current column layout. */ key?: string; /** - * Specifies the primaryKey of the columnLayout. This also serves as the column key for the current column layout. + * Specifies the primaryKey of the columnLayout. This also serves as the column key for the current column layout. */ primaryKey?: string; /** - * Specifies the foreignKey of the columnLayout. This is also the column key of the parent grid. + * Specifies the foreignKey of the columnLayout. This is also the column key of the parent grid. */ foreignKey?: string; /** - * Option for IgHierarchicalGridColumnLayout + * Option for IgHierarchicalGridColumnLayout */ [optionName: string]: any; } @@ -41985,12 +41985,12 @@ interface RowExpandingEvent { interface RowExpandingEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that's about to be expanded + * Used to access the row element for the row that's about to be expanded */ parentrow?: any; } @@ -42001,12 +42001,12 @@ interface RowExpandedEvent { interface RowExpandedEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that was expanded + * Used to access the row element for the row that was expanded */ parentrow?: any; } @@ -42017,12 +42017,12 @@ interface RowCollapsingEvent { interface RowCollapsingEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that's about to be collapsed + * Used to access the row element for the row that's about to be collapsed */ parentrow?: any; } @@ -42033,12 +42033,12 @@ interface RowCollapsedEvent { interface RowCollapsedEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that was collapsd + * Used to access the row element for the row that was collapsd */ parentrow?: any; } @@ -42049,17 +42049,17 @@ interface ChildrenPopulatingEvent { interface ChildrenPopulatingEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that's about to be populated + * Used to access the row element for the row that's about to be populated */ parentrow?: any; /** - * Used to get the data ID of the row + * Used to get the data ID of the row */ id?: any; } @@ -42070,17 +42070,17 @@ interface ChildrenPopulatedEvent { interface ChildrenPopulatedEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that was populated + * Used to access the row element for the row that was populated */ parentrow?: any; /** - * Used to get the data ID of the row + * Used to get the data ID of the row */ id?: any; } @@ -42091,17 +42091,17 @@ interface ChildGridRenderedEvent { interface ChildGridRenderedEventUIParam { /** - * Used to access the hierarchical grid object + * Used to access the hierarchical grid object */ owner?: any; /** - * Used to access the row element for the row that's about to be populated + * Used to access the row element for the row that's about to be populated */ parentrow?: any; /** - * Used to get reference to the child grid + * Used to get reference to the child grid */ childgrid?: any; } @@ -42122,112 +42122,112 @@ interface ChildGridCreatedEventUIParam { interface IgHierarchicalGrid { /** - * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will + * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will */ initialDataBindDepth?: number; /** - * No levels will be automatically expanded when the widget is instantiated for the first time + * No levels will be automatically expanded when the widget is instantiated for the first time */ initialExpandDepth?: number; /** - * If true, encodes all requests using OData conventions and the $expand syntax + * If true, encodes all requests using OData conventions and the $expand syntax */ odata?: boolean; /** - * If true, load on demand will be achieved using REST compliant resource access with appropriate url-s for + * If true, load on demand will be achieved using REST compliant resource access with appropriate url-s for * the ajax GET calls. */ rest?: boolean; /** - * Specifies the limit on the number of levels to bind to + * Specifies the limit on the number of levels to bind to */ maxDataBindDepth?: number; /** - * Specifies the default property in the response where children will be located + * Specifies the default property in the response where children will be located */ defaultChildrenDataProperty?: string; /** - * If true, will autogenerate all layouts assuming default values for "childrenDataProperty" + * If true, will autogenerate all layouts assuming default values for "childrenDataProperty" * When autoGenerateLayouts is enabled, it will automatically generate all columns recursively. (all columns on all levels) */ autoGenerateLayouts?: boolean; /** - * Applies a linear animation - either expanding or collapsing depending on the parent row state + * Applies a linear animation - either expanding or collapsing depending on the parent row state */ expandCollapseAnimations?: boolean; /** - * Specifies the expand column width + * Specifies the expand column width */ expandColWidth?: number; /** - * Specifies the delimiter for constructing paths , for hierarchical lookup of data + * Specifies the delimiter for constructing paths , for hierarchical lookup of data */ pathSeparator?: string; /** - * The row expanding/collapsing animation duration in ms. + * The row expanding/collapsing animation duration in ms. */ animationDuration?: number; /** - * Specifies the default tooltip applied to an expand column cell, that is currently collapsed + * Specifies the default tooltip applied to an expand column cell, that is currently collapsed */ expandTooltip?: string; /** - * Specifies the default tooltip applied to an expand column cell, that is currently expanded + * Specifies the default tooltip applied to an expand column cell, that is currently expanded */ collapseTooltip?: string; /** - * An array of column objects + * An array of column objects */ columns?: any[]; /** - * List of columnLayout objects that specify the structure of the child grids. All options that are applicable to a flat grid are also applicable here + * List of columnLayout objects that specify the structure of the child grids. All options that are applicable to a flat grid are also applicable here */ columnLayouts?: IgHierarchicalGridColumnLayout[]; /** - * Event which is fired when a hierarchical row is about to be expanded + * Event which is fired when a hierarchical row is about to be expanded * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that's about to be expanded */ rowExpanding?: RowExpandingEvent; /** - * Event which is fired after a hierarchical row has been expanded + * Event which is fired after a hierarchical row has been expanded * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that was expanded */ rowExpanded?: RowExpandedEvent; /** - * Event which is fired when a hierarchical row is about to be collapsed + * Event which is fired when a hierarchical row is about to be collapsed * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that's about to be collapsed */ rowCollapsing?: RowCollapsingEvent; /** - * Event which is fired when a hierarchical row has been collapsed + * Event which is fired when a hierarchical row has been collapsed * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that was collapsd */ rowCollapsed?: RowCollapsedEvent; /** - * Event which is fired when children are about to be populated (Load on demand) + * Event which is fired when children are about to be populated (Load on demand) * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that's about to be populated * use args.id to get the data ID of the row @@ -42235,7 +42235,7 @@ interface IgHierarchicalGrid { childrenPopulating?: ChildrenPopulatingEvent; /** - * Event which is fired when children have been populated (Load on demand) + * Event which is fired when children have been populated (Load on demand) * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that was populated * use args.id to get the data ID of the row @@ -42243,7 +42243,7 @@ interface IgHierarchicalGrid { childrenPopulated?: ChildrenPopulatedEvent; /** - * Event fired when child grid is rendered + * Event fired when child grid is rendered * use args.owner to access the hierarchical grid object * use args.parentrow to access the row element for the row that's about to be populated * use args.childgrid to get reference to the child grid @@ -42251,49 +42251,49 @@ interface IgHierarchicalGrid { childGridRendered?: ChildGridRenderedEvent; /** - * Event fired before a child grid is going to be created, allows the developer to override the child grid creation + * Event fired before a child grid is going to be created, allows the developer to override the child grid creation */ childGridCreating?: ChildGridCreatingEvent; /** - * Event fired after a child grid is created + * Event fired after a child grid is created */ childGridCreated?: ChildGridCreatedEvent; /** - * Option for igHierarchicalGrid + * Option for igHierarchicalGrid */ [optionName: string]: any; } interface IgHierarchicalGridMethods { /** - * Data binds the hierarchical grid. No child grids will be created or rendered by default, unless there is initialExpandDepth >= 0 set. + * Data binds the hierarchical grid. No child grids will be created or rendered by default, unless there is initialExpandDepth >= 0 set. */ dataBind(): void; /** - * Returns the element of the root grid (igGrid) + * Returns the element of the root grid (igGrid) */ root(): Object; /** - * Returns the widget object of the root grid (igGrid) + * Returns the widget object of the root grid (igGrid) */ rootWidget(): Object; /** - * Returns a flat list of all child grid widgets (not elements) - recursive + * Returns a flat list of all child grid widgets (not elements) - recursive */ allChildrenWidgets(): Object; /** - * Returns a flat list of all child grid elements (recursive) + * Returns a flat list of all child grid elements (recursive) */ allChildren(): Object; /** - * Expands or collapses (toggles) a parent row - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Expands or collapses (toggles) a parent row + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row * @param callback Specifies a custom function to be called when parent row is toggled(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was toggled @@ -42301,8 +42301,8 @@ interface IgHierarchicalGridMethods { toggle(element: Element, callback?: Function): void; /** - * Expands (toggles) a parent row - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Expands (toggles) a parent row + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments first is hierarchical grid object, second is the row element that was expanded @@ -42310,15 +42310,15 @@ interface IgHierarchicalGridMethods { expand(id: Element, callback?: Function): void; /** - * Checks if a parent row is expanded or not + * Checks if a parent row is expanded or not * * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ expanded(element: Element): boolean; /** - * Collapses a parent row - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Collapses a parent row + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param id accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row * @param callback Specifies a custom function to be called when parent row is expanded(optional). Takes 2 arguments - first is hierarchical grid object, second is the row element that was collapsed @@ -42326,33 +42326,33 @@ interface IgHierarchicalGridMethods { collapse(id: Element, callback?: Function): void; /** - * Checks if a parent row is currently collapsed + * Checks if a parent row is currently collapsed * * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ collapsed(element: Element): boolean; /** - * Checks if a parent row is populated with data + * Checks if a parent row is populated with data * * @param element accepts a dom element, or a jquery wrapped dom element that should be a TR and should specify a parent row */ populated(element: Element): boolean; /** - * Commits pending transactions to the client data source for main and all child grids. + * Commits pending transactions to the client data source for main and all child grids. */ commit(): void; /** - * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. + * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * * @param rebind Whether to perform a rebind. */ rollback(rebind?: boolean): void; /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params * * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) @@ -42360,7 +42360,7 @@ interface IgHierarchicalGridMethods { saveChanges(success: Function, error: Function): void; /** - * Destroys the hierarchical grid by recursively destroying all child grids + * Destroys the hierarchical grid by recursively destroying all child grids */ destroy(): void; } @@ -42722,17 +42722,17 @@ interface GroupCollapsingEvent { interface GroupCollapsingEventUIParam { /** - * Used to get the reference to the GridMultiColumnHeaders widget. + * Used to get the reference to the GridMultiColumnHeaders widget. */ owner?: any; /** - * Used to get the column object for the current group that is collapsing. + * Used to get the column object for the current group that is collapsing. */ column?: any; /** - * Used to get a reference to the jQuery object for the column being collapsing (th). + * Used to get a reference to the jQuery object for the column being collapsing (th). */ element?: any; } @@ -42743,17 +42743,17 @@ interface GroupCollapsedEvent { interface GroupCollapsedEventUIParam { /** - * Used to get the reference to the GridMultiColumnHeaders widget. + * Used to get the reference to the GridMultiColumnHeaders widget. */ owner?: any; /** - * Used to get the column object for the current group that is collapsed. + * Used to get the column object for the current group that is collapsed. */ column?: any; /** - * Used to get a reference to the jQuery object for the column being collapsed (th). + * Used to get a reference to the jQuery object for the column being collapsed (th). */ element?: any; } @@ -42764,17 +42764,17 @@ interface GroupExpandingEvent { interface GroupExpandingEventUIParam { /** - * Used to get the reference to the GridMultiColumnHeaders widget. + * Used to get the reference to the GridMultiColumnHeaders widget. */ owner?: any; /** - * Used to get the column object for the current group that is expanding. + * Used to get the column object for the current group that is expanding. */ column?: any; /** - * Used to get a reference to the jQuery object for the column being expanded (th). + * Used to get a reference to the jQuery object for the column being expanded (th). */ element?: any; } @@ -42785,29 +42785,29 @@ interface GroupExpandedEvent { interface GroupExpandedEventUIParam { /** - * Used to get the reference to the GridMultiColumnHeaders widget. + * Used to get the reference to the GridMultiColumnHeaders widget. */ owner?: any; /** - * Used to get the column object for the current group that is expanded. + * Used to get the column object for the current group that is expanded. */ column?: any; /** - * Used to get a reference to the jQuery object for the column being expanded (th). + * Used to get a reference to the jQuery object for the column being expanded (th). */ element?: any; } interface IgGridMultiColumnHeaders { /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before a group collapsing operation is executed. + * Event fired before a group collapsing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -42817,7 +42817,7 @@ interface IgGridMultiColumnHeaders { groupCollapsing?: GroupCollapsingEvent; /** - * Event fired after the group collapsing has been executed and results are rendered. + * Event fired after the group collapsing has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -42827,7 +42827,7 @@ interface IgGridMultiColumnHeaders { groupCollapsed?: GroupCollapsedEvent; /** - * Event fired before a group expanding operation is executed. + * Event fired before a group expanding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -42837,7 +42837,7 @@ interface IgGridMultiColumnHeaders { groupExpanding?: GroupExpandingEvent; /** - * Event fired after the group expanding has been executed and results are rendered. + * Event fired after the group expanding has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -42847,13 +42847,13 @@ interface IgGridMultiColumnHeaders { groupExpanded?: GroupExpandedEvent; /** - * Option for igGridMultiColumnHeaders + * Option for igGridMultiColumnHeaders */ [optionName: string]: any; } interface IgGridMultiColumnHeadersMethods { /** - * Expands a collapsed group. If the group is expanded, the method does nothing. + * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -42862,7 +42862,7 @@ interface IgGridMultiColumnHeadersMethods { expandGroup(groupKey: string, callback?: Function): void; /** - * Collapses an expanded group. If the group is collapsed, the method does nothing. + * Collapses an expanded group. If the group is collapsed, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -42871,7 +42871,7 @@ interface IgGridMultiColumnHeadersMethods { collapseGroup(groupKey: string, callback?: Function): void; /** - * Toggles a collapsible group. + * Toggles a collapsible group. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -42880,12 +42880,12 @@ interface IgGridMultiColumnHeadersMethods { toggleGroup(groupKey: string, callback?: Function): void; /** - * Returns multicolumn headers array. if there aren"t multicolumn headers returns undefined + * Returns multicolumn headers array. if there aren"t multicolumn headers returns undefined */ getMultiColumnHeaders(): any[]; /** - * Destroys the multicolumn widget + * Destroys the multicolumn widget */ destroy(): void; } @@ -43011,17 +43011,17 @@ interface PageIndexChangingEvent { interface PageIndexChangingEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get current page index. + * Used to get current page index. */ currentPageIndex?: any; /** - * Used to get new page index. + * Used to get new page index. */ newPageIndex?: any; } @@ -43032,12 +43032,12 @@ interface PageIndexChangedEvent { interface PageIndexChangedEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get current page index. + * Used to get current page index. */ pageIndex?: any; } @@ -43048,17 +43048,17 @@ interface PageSizeChangingEvent { interface PageSizeChangingEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get current page size. + * Used to get current page size. */ currentPageSize?: any; /** - * Used to get new page size. + * Used to get new page size. */ newPageSize?: any; } @@ -43069,12 +43069,12 @@ interface PageSizeChangedEvent { interface PageSizeChangedEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get current page size. + * Used to get current page size. */ pageSize?: any; } @@ -43085,12 +43085,12 @@ interface PagerRenderingEvent { interface PagerRenderingEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get reference to grid's data source. + * Used to get reference to grid's data source. */ dataSource?: any; } @@ -43101,49 +43101,49 @@ interface PagerRenderedEvent { interface PagerRenderedEventUIParam { /** - * Used to get reference to GridPaging. + * Used to get reference to GridPaging. */ owner?: any; /** - * Used to get reference to grid's data source. + * Used to get reference to grid's data source. */ dataSource?: any; } interface IgGridPaging { /** - * Number of records loaded and displayed per page. + * Number of records loaded and displayed per page. * */ pageSize?: number; /** - * The property in the response data, when using remote data source, that will hold the total number of records in the data source. + * The property in the response data, when using remote data source, that will hold the total number of records in the data source. * */ recordCountKey?: string; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page size. + * Denotes the name of the encoded URL parameter that will state what is the currently requested page size. * */ pageSizeUrlKey?: string; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page index. + * Denotes the name of the encoded URL parameter that will state what is the currently requested page index. * */ pageIndexUrlKey?: string; /** - * Current page index that's bound in the data source and rendered in the UI. + * Current page index that's bound in the data source and rendered in the UI. * */ currentPageIndex?: number; /** - * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). + * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). * * * Valid values: @@ -43153,25 +43153,25 @@ interface IgGridPaging { type?: string; /** - * If false, a dropdown allowing to change the page size will not be rendered in the UI. + * If false, a dropdown allowing to change the page size will not be rendered in the UI. * */ showPageSizeDropDown?: boolean; /** - * Text rendered in front of the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. + * Text rendered in front of the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. * */ pageSizeDropDownLabel?: string; /** - * Trailing text for the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. + * Trailing text for the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. * */ pageSizeDropDownTrailingLabel?: string; /** - * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. + * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. * * * Valid values: @@ -43181,157 +43181,157 @@ interface IgGridPaging { pageSizeDropDownLocation?: string; /** - * Option specifying whether to show summary label for the currently rendered records or not. + * Option specifying whether to show summary label for the currently rendered records or not. * */ showPagerRecordsLabel?: boolean; /** - * Custom pager records label template - in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. + * Custom pager records label template - in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. * */ pagerRecordsLabelTemplate?: string; /** - * Text for the next page label. + * Text for the next page label. * */ nextPageLabelText?: string; /** - * Text for the previous page label. + * Text for the previous page label. * */ prevPageLabelText?: string; /** - * Text for the first page label. + * Text for the first page label. * */ firstPageLabelText?: string; /** - * Text for the last page label. + * Text for the last page label. * */ lastPageLabelText?: string; /** - * Option specifying whether to render the first and last page navigation buttons. + * Option specifying whether to render the first and last page navigation buttons. * */ showFirstLastPages?: boolean; /** - * Option specifying whether to render the previous and next page navigation buttons. + * Option specifying whether to render the previous and next page navigation buttons. * */ showPrevNextPages?: boolean; /** - * Leading label text for the drop down from where the page index can be switched. + * Leading label text for the drop down from where the page index can be switched. * */ currentPageDropDownLeadingLabel?: string; /** - * Trailing label text for the drop down from where the page index can be switched. + * Trailing label text for the drop down from where the page index can be switched. * */ currentPageDropDownTrailingLabel?: string; /** - * Tooltip text for the page index drop down. + * Tooltip text for the page index drop down. * */ currentPageDropDownTooltip?: string; /** - * Tooltip text for the page size drop down. + * Tooltip text for the page size drop down. * */ pageSizeDropDownTooltip?: string; /** - * Tooltip text for the pager records label. + * Tooltip text for the pager records label. * */ pagerRecordsLabelTooltip?: string; /** - * Tooltip text for the previous page button. + * Tooltip text for the previous page button. * */ prevPageTooltip?: string; /** - * Tooltip text for the next page button. + * Tooltip text for the next page button. * */ nextPageTooltip?: string; /** - * Tooltip text for the first page button. + * Tooltip text for the first page button. * */ firstPageTooltip?: string; /** - * Tooltip text for the last page button. + * Tooltip text for the last page button. * */ lastPageTooltip?: string; /** - * Tooltip text templates of buttons that navigate to a particular page. The format string follows the [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. See also the [pageCountLimit](ui.iggridpaging#options:pageCountLimit) option. + * Tooltip text templates of buttons that navigate to a particular page. The format string follows the [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. See also the [pageCountLimit](ui.iggridpaging#options:pageCountLimit) option. * */ pageTooltipFormat?: string; /** - * Predefined page sizes that are available to the end user to switch their grid paging to, through a drop down in the grid header. + * Predefined page sizes that are available to the end user to switch their grid paging to, through a drop down in the grid header. * */ pageSizeList?: any; /** - * Sets/Gets the number of pages which if exceeded a drop down list of page indices is displayed. If the number of pages is less than or equal to this option then buttons for each page are displayed. + * Sets/Gets the number of pages which if exceeded a drop down list of page indices is displayed. If the number of pages is less than or equal to this option then buttons for each page are displayed. * */ pageCountLimit?: number; /** - * Number of page buttons, adjacent to and including the [active page](ui.iggridpaging#options:currentPageIndex), that are constantly visible. For the invisible pages, previous and next buttons are used. + * Number of page buttons, adjacent to and including the [active page](ui.iggridpaging#options:currentPageIndex), that are constantly visible. For the invisible pages, previous and next buttons are used. * */ visiblePageCount?: number; /** - * Drop down width for the page size and page index drop downs. + * Drop down width for the page size and page index drop downs. * */ defaultDropDownWidth?: number; /** - * Time in milliseconds for which page drop down will wait for keystrokes before changing the page. + * Time in milliseconds for which page drop down will wait for keystrokes before changing the page. * */ delayOnPageChanged?: number; /** - * Enables/disables paging persistence between states. + * Enables/disables paging persistence between states. * */ persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before the page index is changed. + * Event fired before the page index is changed. * Return false in order to cancel page index changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -43342,7 +43342,7 @@ interface IgGridPaging { pageIndexChanging?: PageIndexChangingEvent; /** - * Event fired after the page index is changed , but before grid data rebinds + * Event fired after the page index is changed , but before grid data rebinds * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -43351,7 +43351,7 @@ interface IgGridPaging { pageIndexChanged?: PageIndexChangedEvent; /** - * Event fired when the page size is about to be changed from the page size dropdown. + * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -43362,7 +43362,7 @@ interface IgGridPaging { pageSizeChanging?: PageSizeChangingEvent; /** - * Event fired after the page size is changed from the page size dropdown. + * Event fired after the page size is changed from the page size dropdown. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -43371,7 +43371,7 @@ interface IgGridPaging { pageSizeChanged?: PageSizeChangedEvent; /** - * Event fired before the pager footer is rendered (the whole area below the grid records). + * Event fired before the pager footer is rendered (the whole area below the grid records). * Return false in order to cancel pager footer rendering. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -43381,7 +43381,7 @@ interface IgGridPaging { pagerRendering?: PagerRenderingEvent; /** - * Event fired after the pager footer is rendered + * Event fired after the pager footer is rendered * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -43390,27 +43390,27 @@ interface IgGridPaging { pagerRendered?: PagerRenderedEvent; /** - * Option for igGridPaging + * Option for igGridPaging */ [optionName: string]: any; } interface IgGridPagingMethods { /** - * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). + * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * * @param index The page index to go to. */ pageIndex(index?: number): number; /** - * Gets/Sets the page size. If no parameter is specified, just returns the current page size. + * Gets/Sets the page size. If no parameter is specified, just returns the current page size. * * @param size The new page size. */ pageSize(size?: number): number; /** - * Destroys the igGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging. + * Destroys the igGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging. */ destroy(): void; } @@ -44050,37 +44050,37 @@ interface JQuery { } interface IgGridResizingColumnSetting { /** - * Column key. this is a required property in every column setting if columnIndex is not set. + * Column key. this is a required property in every column setting if columnIndex is not set. * */ columnKey?: string; /** - * Column index. Can be used in place of column key. the preferred way of populating a column setting is to always use the column keys as identifiers. + * Column index. Can be used in place of column key. the preferred way of populating a column setting is to always use the column keys as identifiers. * */ columnIndex?: number; /** - * Enables disables resizing for the column. + * Enables disables resizing for the column. * */ allowResizing?: boolean; /** - * Minimum column width in pixels or percents. + * Minimum column width in pixels or percents. * */ minimumWidth?: string|number; /** - * Maximum column width in pixels or percents. + * Maximum column width in pixels or percents. * */ maximumWidth?: string|number; /** - * Option for IgGridResizingColumnSetting + * Option for IgGridResizingColumnSetting */ [optionName: string]: any; } @@ -44091,22 +44091,22 @@ interface ColumnResizingEvent { interface ColumnResizingEventUIParam { /** - * Used to get the reference to the GridResizing widget. + * Used to get the reference to the GridResizing widget. */ owner?: any; /** - * Used to get the resized column index. + * Used to get the resized column index. */ columnIndex?: any; /** - * Used to get the resized column key. + * Used to get the resized column key. */ columnKey?: any; /** - * Used to get the desired width(before min/max coercion) for the resized column. + * Used to get the desired width(before min/max coercion) for the resized column. */ desiredWidth?: any; } @@ -44117,22 +44117,22 @@ interface ColumnResizingRefusedEvent { interface ColumnResizingRefusedEventUIParam { /** - * Used to get the reference to the GridResizing widget. + * Used to get the reference to the GridResizing widget. */ owner?: any; /** - * Used to get the resized column index. + * Used to get the resized column index. */ columnIndex?: any; /** - * Used to get the resized column key. + * Used to get the resized column key. */ columnKey?: any; /** - * Used to get the desired width(before min/max coercion) for the resized column. + * Used to get the desired width(before min/max coercion) for the resized column. */ desiredWidth?: any; } @@ -44143,63 +44143,63 @@ interface ColumnResizedEvent { interface ColumnResizedEventUIParam { /** - * Used to get the reference to the GridResizing widget. + * Used to get the reference to the GridResizing widget. */ owner?: any; /** - * Used to get the resized column index. + * Used to get the resized column index. */ columnIndex?: any; /** - * Used to get the resized column key. + * Used to get the resized column key. */ columnKey?: any; /** - * Used to get the original column width. + * Used to get the original column width. */ originalWidth?: any; /** - * Used to get the final column width after resizing. + * Used to get the final column width after resizing. */ newWidth?: any; } interface IgGridResizing { /** - * Resize the column to the size of the longest currently visible cell value. + * Resize the column to the size of the longest currently visible cell value. * */ allowDoubleClickToResize?: boolean; /** - * Specifies whether the resizing should be deferred until the user finishes resizing or applied immediately. + * Specifies whether the resizing should be deferred until the user finishes resizing or applied immediately. * */ deferredResizing?: boolean; /** - * A list of column settings that specifies resizing options on a per column basis. + * A list of column settings that specifies resizing options on a per column basis. * */ columnSettings?: IgGridResizingColumnSetting[]; /** - * The width in pixels of the resizing handle which is position at the right side of each resizeable column header. + * The width in pixels of the resizing handle which is position at the right side of each resizeable column header. * */ handleThreshold?: number; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before a resizing operation is executed. + * Event fired before a resizing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -44210,7 +44210,7 @@ interface IgGridResizing { columnResizing?: ColumnResizingEvent; /** - * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) + * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -44221,7 +44221,7 @@ interface IgGridResizing { columnResizingRefused?: ColumnResizingRefusedEvent; /** - * Event fired after the resizing has been executed and results are rendered + * Event fired after the resizing has been executed and results are rendered * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -44233,18 +44233,18 @@ interface IgGridResizing { columnResized?: ColumnResizedEvent; /** - * Option for igGridResizing + * Option for igGridResizing */ [optionName: string]: any; } interface IgGridResizingMethods { /** - * Destroys the resizing widget + * Destroys the resizing widget */ destroy(): void; /** - * Resizes a column to a specified width in pixels, percents or auto if no width is specified. + * Resizes a column to a specified width in pixels, percents or auto if no width is specified. * * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). @@ -44408,68 +44408,68 @@ interface JQuery { } interface IgGridResponsiveColumnSetting { /** - * Column key. This is a required property in every column setting if columnIndex is not set. + * Column key. This is a required property in every column setting if columnIndex is not set. * */ columnKey?: string; /** - * Column index. Can be used in place of column key. The preferred way of populating a column setting is to always use the column keys as identifiers. + * Column index. Can be used in place of column key. The preferred way of populating a column setting is to always use the column keys as identifiers. * */ columnIndex?: number; /** - * A list of predefined classes to decide element's visibility on. + * A list of predefined classes to decide element's visibility on. * */ classes?: string; /** - * A configuration object to use for the responsive functionality. Uses the keys defined in the widget's responsiveModes object. The classes property is not used if this one is set. + * A configuration object to use for the responsive functionality. Uses the keys defined in the widget's responsiveModes object. The classes property is not used if this one is set. * */ configuration?: any; /** - * Option for IgGridResponsiveColumnSetting + * Option for IgGridResponsiveColumnSetting */ [optionName: string]: any; } interface IgGridResponsiveAllowedColumnWidthPerType { /** - * Minimal width in pixels string columns can take before forcing vertical rendering + * Minimal width in pixels string columns can take before forcing vertical rendering * */ string?: number; /** - * Minimal width in pixels number columns can take before forcing vertical rendering + * Minimal width in pixels number columns can take before forcing vertical rendering * */ number?: number; /** - * Minimal width in pixels bool columns can take before forcing vertical rendering + * Minimal width in pixels bool columns can take before forcing vertical rendering * */ bool?: number; /** - * Minimal width in pixels date columns can take before forcing vertical rendering + * Minimal width in pixels date columns can take before forcing vertical rendering * */ date?: number; /** - * Minimal width in pixels object columns can take before forcing vertical rendering + * Minimal width in pixels object columns can take before forcing vertical rendering * */ object?: number; /** - * Option for IgGridResponsiveAllowedColumnWidthPerType + * Option for IgGridResponsiveAllowedColumnWidthPerType */ [optionName: string]: any; } @@ -44480,17 +44480,17 @@ interface ResponsiveColumnHidingEvent { interface ResponsiveColumnHidingEventUIParam { /** - * Used to get the reference to the igGridResponsive widget. + * Used to get the reference to the igGridResponsive widget. */ owner?: any; /** - * Used to get the hidden column index. Has a value only if the column's key is a number. + * Used to get the hidden column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the hidden column key. Has a value only if the column's key is a string. + * Used to get the hidden column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -44501,17 +44501,17 @@ interface ResponsiveColumnHiddenEvent { interface ResponsiveColumnHiddenEventUIParam { /** - * Used to get the reference to the igGridResponsive widget. + * Used to get the reference to the igGridResponsive widget. */ owner?: any; /** - * Used to get the hidden column index. Has a value only if the column's key is a number. + * Used to get the hidden column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the hidden column key. Has a value only if the column's key is a string. + * Used to get the hidden column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -44522,17 +44522,17 @@ interface ResponsiveColumnShowingEvent { interface ResponsiveColumnShowingEventUIParam { /** - * Used to get the reference to the igGridResponsive widget. + * Used to get the reference to the igGridResponsive widget. */ owner?: any; /** - * Used to get the shown column index. Has a value only if the column's key is a number. + * Used to get the shown column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the shown column key. Has a value only if the column's key is a string. + * Used to get the shown column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -44543,17 +44543,17 @@ interface ResponsiveColumnShownEvent { interface ResponsiveColumnShownEventUIParam { /** - * Used to get the reference to the igGridResponsive widget. + * Used to get the reference to the igGridResponsive widget. */ owner?: any; /** - * Used to get the shown column index. Has a value only if the column's key is a number. + * Used to get the shown column index. Has a value only if the column's key is a number. */ columnIndex?: any; /** - * Used to get the shown column key. Has a value only if the column's key is a string. + * Used to get the shown column key. Has a value only if the column's key is a string. */ columnKey?: any; } @@ -44564,60 +44564,60 @@ interface ResponsiveModeChangedEvent { interface ResponsiveModeChangedEventUIParam { /** - * Used to get the reference to the igGridResponsive widget. + * Used to get the reference to the igGridResponsive widget. */ owner?: any; /** - * Used to get the previously assumed mode. + * Used to get the previously assumed mode. */ previousMode?: any; /** - * Used to get the newly assumed mode. + * Used to get the newly assumed mode. */ mode?: any; } interface IgGridResponsive { /** - * A list of column settings that specifies how columns will react based on the environment the grid is run on. + * A list of column settings that specifies how columns will react based on the environment the grid is run on. * */ columnSettings?: IgGridResponsiveColumnSetting[]; /** - * If this option is set to true an igResponsiveContainer widget will be attached to the igGrid control which will notify the feature when changes in the width of the container occur. + * If this option is set to true an igResponsiveContainer widget will be attached to the igGrid control which will notify the feature when changes in the width of the container occur. * */ reactOnContainerWidthChanges?: boolean; /** - * If this option is set to true the widget will ensure the grid's width is always set to 100%. + * If this option is set to true the widget will ensure the grid's width is always set to 100%. * */ forceResponsiveGridWidth?: boolean; /** - * The amount of pixels the window needs to resize with for the grid to respond. + * The amount of pixels the window needs to resize with for the grid to respond. * */ responsiveSensitivity?: number; /** - * The recognized types of environments and their configuration. + * The recognized types of environments and their configuration. * */ responsiveModes?: any; /** - * Enable or disable the responsive vertical rendering for the grid. + * Enable or disable the responsive vertical rendering for the grid. * */ enableVerticalRendering?: boolean; /** - * The window's width under which the grid will render its contents vertically. + * The window's width under which the grid will render its contents vertically. * * * Valid values: @@ -44628,7 +44628,7 @@ interface IgGridResponsive { windowWidthToRenderVertically?: string|number; /** - * The width of the properties column when vertical rendering is enabled + * The width of the properties column when vertical rendering is enabled * * * Valid values: @@ -44638,7 +44638,7 @@ interface IgGridResponsive { propertiesColumnWidth?: string|number; /** - * The width of the values column when vertical rendering is enabled + * The width of the values column when vertical rendering is enabled * * * Valid values: @@ -44648,25 +44648,25 @@ interface IgGridResponsive { valuesColumnWidth?: string|number; /** - * When windowWidthToRenderVertically is null, determine minimal widths columns can take before + * When windowWidthToRenderVertically is null, determine minimal widths columns can take before * forcing vertical rendering for the grid * */ allowedColumnWidthPerType?: IgGridResponsiveAllowedColumnWidthPerType; /** - * Specifies a template to render a record with in a list-view style layout per mode. + * Specifies a template to render a record with in a list-view style layout per mode. * */ singleColumnTemplate?: any; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before a hiding operation is executed on a collection of columns. + * Event fired before a hiding operation is executed on a collection of columns. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridResponsive widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -44676,7 +44676,7 @@ interface IgGridResponsive { responsiveColumnHiding?: ResponsiveColumnHidingEvent; /** - * Event fired after a hiding operation is executed on the collection of columns. + * Event fired after a hiding operation is executed on the collection of columns. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridResponsive widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -44686,7 +44686,7 @@ interface IgGridResponsive { responsiveColumnHidden?: ResponsiveColumnHiddenEvent; /** - * Event fired before a showing operation is executed on a collection of columns. + * Event fired before a showing operation is executed on a collection of columns. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridResponsive widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -44696,7 +44696,7 @@ interface IgGridResponsive { responsiveColumnShowing?: ResponsiveColumnShowingEvent; /** - * Event fired after a showing operation is executed on the collection of columns. + * Event fired after a showing operation is executed on the collection of columns. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridResponsive widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -44706,7 +44706,7 @@ interface IgGridResponsive { responsiveColumnShown?: ResponsiveColumnShownEvent; /** - * Event which is fired when the widget detects an environment change. + * Event which is fired when the widget detects an environment change. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridResponsive widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -44716,18 +44716,18 @@ interface IgGridResponsive { responsiveModeChanged?: ResponsiveModeChangedEvent; /** - * Option for igGridResponsive + * Option for igGridResponsive */ [optionName: string]: any; } interface IgGridResponsiveMethods { /** - * Destroys the responsive widget. + * Destroys the responsive widget. */ destroy(): void; /** - * Returns the currently active responsive mode. + * Returns the currently active responsive mode. */ getCurrentResponsiveMode(): void; } @@ -44742,7 +44742,7 @@ interface ResponsiveModeSettings { maxHeight?: any; /** - * Option for ResponsiveModeSettings + * Option for ResponsiveModeSettings */ [optionName: string]: any; } @@ -44762,7 +44762,7 @@ interface InfragisticsModeSettings { visibilityTester?: any; /** - * Option for InfragisticsModeSettings + * Option for InfragisticsModeSettings */ [optionName: string]: any; } @@ -44782,7 +44782,7 @@ interface BootstrapModeSettings { visibilityTester?: any; /** - * Option for BootstrapModeSettings + * Option for BootstrapModeSettings */ [optionName: string]: any; } @@ -45090,37 +45090,37 @@ interface RowSelectorClickedEvent { interface RowSelectorClickedEventUIParam { /** - * Used to get reference to the row the clicked row selector resides in. + * Used to get reference to the row the clicked row selector resides in. */ row?: any; /** - * Used to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). + * Used to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). */ fixedRow?: any; /** - * Used to get the index of the row the clicked row selector resides in. + * Used to get the index of the row the clicked row selector resides in. */ rowIndex?: any; /** - * Used to get the key of the row the clicked row selector resides in. + * Used to get the key of the row the clicked row selector resides in. */ rowKey?: any; /** - * Used tor to get reference to the row selector cell. + * Used tor to get reference to the row selector cell. */ rowSelector?: any; /** - * Used to get reference to RowSelectors. + * Used to get reference to RowSelectors. */ owner?: any; /** - * Used to get reference to the grid the RowSelectors are initialized for. + * Used to get reference to the grid the RowSelectors are initialized for. */ grid?: any; } @@ -45131,47 +45131,47 @@ interface CheckBoxStateChangingEvent { interface CheckBoxStateChangingEventUIParam { /** - * Used to get reference to the row the clicked row selector resides in. + * Used to get reference to the row the clicked row selector resides in. */ row?: any; /** - * Used to get the index of the row the clicked row selector resides in. + * Used to get the index of the row the clicked row selector resides in. */ rowIndex?: any; /** - * Used to get the key of the row the clicked row selector resides in. + * Used to get the key of the row the clicked row selector resides in. */ rowKey?: any; /** - * Used tor to get reference to the row selector cell. + * Used tor to get reference to the row selector cell. */ rowSelector?: any; /** - * Used to get reference to igRowSelectors. + * Used to get reference to igRowSelectors. */ owner?: any; /** - * Used to get reference to the grid the RowSelectors are initialized for. + * Used to get reference to the grid the RowSelectors are initialized for. */ grid?: any; /** - * Used to get the current state of the checkbox ("on","off"). + * Used to get the current state of the checkbox ("on","off"). */ currentState?: any; /** - * Used to get the new state of the checkbox ("on","off"). + * Used to get the new state of the checkbox ("on","off"). */ newState?: any; /** - * Used to check if the header check box is the one being clicked. In this case no row related args are passed. + * Used to check if the header check box is the one being clicked. In this case no row related args are passed. */ isHeader?: any; } @@ -45182,67 +45182,67 @@ interface CheckBoxStateChangedEvent { interface CheckBoxStateChangedEventUIParam { /** - * Used to get reference to the row the clicked row selector resides in. + * Used to get reference to the row the clicked row selector resides in. */ row?: any; /** - * Used to get the index of the row the clicked row selector resides in. + * Used to get the index of the row the clicked row selector resides in. */ rowIndex?: any; /** - * Used to get the key of the row the clicked row selector resides in. + * Used to get the key of the row the clicked row selector resides in. */ rowKey?: any; /** - * Used tor to get reference to the row selector cell. + * Used tor to get reference to the row selector cell. */ rowSelector?: any; /** - * Used to get reference to igRowSelectors. + * Used to get reference to igRowSelectors. */ owner?: any; /** - * Used to get reference to the grid the RowSelectors are initialized for. + * Used to get reference to the grid the RowSelectors are initialized for. */ grid?: any; /** - * Used to get the state of the checkbox ("on","off"). + * Used to get the state of the checkbox ("on","off"). */ state?: any; /** - * Used to check if the header check box is the one being clicked. In this case no row related args are passed. + * Used to check if the header check box is the one being clicked. In this case no row related args are passed. */ isHeader?: any; } interface IgGridRowSelectors { /** - * Determines whether the row selectors column should contain row numbering + * Determines whether the row selectors column should contain row numbering * */ enableRowNumbering?: boolean; /** - * Determines whether the row selectors column should contain checkboxes + * Determines whether the row selectors column should contain checkboxes * */ enableCheckBoxes?: boolean; /** - * The seed to be added to the default numbering + * The seed to be added to the default numbering * */ rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -45252,7 +45252,7 @@ interface IgGridRowSelectors { rowSelectorColumnWidth?: string|number; /** - * Determines whether the selection feature is required for the row selectors. If set to "false" + * Determines whether the selection feature is required for the row selectors. If set to "false" * the widget will not check for Selection availability. If set to "true" an exception will be thrown if Selection is * not available. * @@ -45260,24 +45260,24 @@ interface IgGridRowSelectors { requireSelection?: boolean; /** - * Determines whether checkboxes will be shown only if row selectors are on focus/selected. + * Determines whether checkboxes will be shown only if row selectors are on focus/selected. * */ showCheckBoxesOnFocus?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Enables/disables showing an overlay after clicking on the header checkbox, which allows selecting all records from all pages. + * Enables/disables showing an overlay after clicking on the header checkbox, which allows selecting all records from all pages. * */ enableSelectAllForPaging?: boolean; /** - * Custom template for "select all" overlay with paging + * Custom template for "select all" overlay with paging * Element with attribute data-rs-select-all is used for sellecting all the records * Element with attribute data-rs-close-all is used for closing the overlay * The default template is "
You have selected ${checked} records. Select all ${totalRecordsCount} records
" @@ -45287,7 +45287,7 @@ interface IgGridRowSelectors { selectAllForPagingTemplate?: string; /** - * Custom template for "deselect all" overlay with paging + * Custom template for "deselect all" overlay with paging * Element with attribute data-rs-deselect-all is used for sellecting all the records * Element with attribute data-rs-close-all is used for closing the overlay * The default template is "
You have deselected ${unchecked} records. Deselect all ${totalRecordsCount} records
" @@ -45297,7 +45297,7 @@ interface IgGridRowSelectors { deselectAllForPagingTemplate?: string; /** - * Event fired after a row selector is clicked. + * Event fired after a row selector is clicked. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). @@ -45310,7 +45310,7 @@ interface IgGridRowSelectors { rowSelectorClicked?: RowSelectorClickedEvent; /** - * Event fired when a row selector checkbox is changing. + * Event fired when a row selector checkbox is changing. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.rowIndex to get the index of the row the clicked row selector resides in. @@ -45325,7 +45325,7 @@ interface IgGridRowSelectors { checkBoxStateChanging?: CheckBoxStateChangingEvent; /** - * Event fired after a row selector checkbox had changed state. + * Event fired after a row selector checkbox had changed state. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.rowIndex to get the index of the row the clicked row selector resides in. @@ -45339,7 +45339,7 @@ interface IgGridRowSelectors { checkBoxStateChanged?: CheckBoxStateChangedEvent; /** - * Option for igGridRowSelectors + * Option for igGridRowSelectors */ [optionName: string]: any; } @@ -45610,27 +45610,27 @@ interface RowSelectionChangingEvent { interface RowSelectionChangingEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to row object. + * Used to get reference to row object. */ row?: any; /** - * Used to get reference to rows object array. + * Used to get reference to rows object array. */ selectedRows?: any; /** - * Used to get the start index for a range row selection. + * Used to get the start index for a range row selection. */ startIndex?: any; /** - * Used to get the end index for a range row selection. + * Used to get the end index for a range row selection. */ endIndex?: any; } @@ -45641,17 +45641,17 @@ interface RowSelectionChangedEvent { interface RowSelectionChangedEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to row object. + * Used to get reference to row object. */ row?: any; /** - * Used to get reference to rows object array. + * Used to get reference to rows object array. */ selectedRows?: any; } @@ -45662,37 +45662,37 @@ interface CellSelectionChangingEvent { interface CellSelectionChangingEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to cell object. + * Used to get reference to cell object. */ cell?: any; /** - * Used to get reference to selected cells object array. + * Used to get reference to selected cells object array. */ selectedCells?: any; /** - * Used to get the column index for the first cell in a range selection. + * Used to get the column index for the first cell in a range selection. */ firstColumnIndex?: any; /** - * Used to get the row index for the first cell in a range selection. + * Used to get the row index for the first cell in a range selection. */ firstRowIndex?: any; /** - * Used to get the column index for the last cell in a range selection. + * Used to get the column index for the last cell in a range selection. */ lastColumnIndex?: any; /** - * Used to get the row index for the last cell in a range selection. + * Used to get the row index for the last cell in a range selection. */ lastRowIndex?: any; } @@ -45703,17 +45703,17 @@ interface CellSelectionChangedEvent { interface CellSelectionChangedEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to cell object. + * Used to get reference to cell object. */ cell?: any; /** - * Used to get reference to selected cells object array. + * Used to get reference to selected cells object array. */ selectedCells?: any; } @@ -45724,12 +45724,12 @@ interface ActiveCellChangingEvent { interface ActiveCellChangingEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to cell object. + * Used to get reference to cell object. */ cell?: any; } @@ -45740,12 +45740,12 @@ interface ActiveCellChangedEvent { interface ActiveCellChangedEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to cell object. + * Used to get reference to cell object. */ cell?: any; } @@ -45756,12 +45756,12 @@ interface ActiveRowChangingEvent { interface ActiveRowChangingEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to row object. + * Used to get reference to row object. */ row?: any; } @@ -45772,31 +45772,31 @@ interface ActiveRowChangedEvent { interface ActiveRowChangedEventUIParam { /** - * Used to get reference to GridSelection. + * Used to get reference to GridSelection. */ owner?: any; /** - * Used to get reference to row object. + * Used to get reference to row object. */ row?: any; } interface IgGridSelection { /** - * Enables / Disables multiple selection of cells and rows - depending on the mode + * Enables / Disables multiple selection of cells and rows - depending on the mode * */ multipleSelection?: boolean; /** - * Enables / disables selection via dragging with the mouse - only applicable for cell selection + * Enables / disables selection via dragging with the mouse - only applicable for cell selection * */ mouseDragSelect?: boolean; /** - * Defines type of the selection. + * Defines type of the selection. * * * Valid values: @@ -45806,49 +45806,49 @@ interface IgGridSelection { mode?: string; /** - * Enables / disables activation of rows and cells. Activation implies ability to perform navigating through cells and rows via the keyboard, and selecting rows and cells using CTRL / SHIFT - in the way cells/rows are selected in Ms Excel + * Enables / disables activation of rows and cells. Activation implies ability to perform navigating through cells and rows via the keyboard, and selecting rows and cells using CTRL / SHIFT - in the way cells/rows are selected in Ms Excel * */ activation?: boolean; /** - * If wrapAround is enabled and selection is on the first or last row or cell, then when the end user tries to go beyond that, the first/last row or cell will be selected + * If wrapAround is enabled and selection is on the first or last row or cell, then when the end user tries to go beyond that, the first/last row or cell will be selected * */ wrapAround?: boolean; /** - * If true will basically skip going into child grids with down / up / right / left arrow keys, when in the context of hierarchical grid + * If true will basically skip going into child grids with down / up / right / left arrow keys, when in the context of hierarchical grid * */ skipChildren?: boolean; /** - * If true multiple selection of cells is done as if CTRL is being held. the option is disregarded if mode is set to row. this option is useful for enabling multiple discountinued selection on touch environments. + * If true multiple selection of cells is done as if CTRL is being held. the option is disregarded if mode is set to row. this option is useful for enabling multiple discountinued selection on touch environments. * */ multipleCellSelectOnClick?: boolean; /** - * Enables / disables selection via continuous touch event - only applicable for cell selection and touch-supported environments + * Enables / disables selection via continuous touch event - only applicable for cell selection and touch-supported environments * */ touchDragSelect?: boolean; /** - * Enables / disables selection persistance between states. + * Enables / disables selection persistance between states. * */ persist?: boolean; /** - * Enables / disables the ability to ctrl drag multiple selection windows when selection mode is 'cell' + * Enables / disables the ability to ctrl drag multiple selection windows when selection mode is 'cell' * */ allowMultipleRangeSelection?: boolean; /** - * Event fired before row(s) are about to be selected (cancellable). + * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -45864,7 +45864,7 @@ interface IgGridSelection { rowSelectionChanging?: RowSelectionChangingEvent; /** - * Event fired after row(s) are selected. + * Event fired after row(s) are selected. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -45877,7 +45877,7 @@ interface IgGridSelection { rowSelectionChanged?: RowSelectionChangedEvent; /** - * Event fired before cell(s) are about to be selected (cancellable). + * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -45898,7 +45898,7 @@ interface IgGridSelection { cellSelectionChanging?: CellSelectionChangingEvent; /** - * Event fired after cell(s) are selected. + * Event fired after cell(s) are selected. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -45914,7 +45914,7 @@ interface IgGridSelection { cellSelectionChanged?: CellSelectionChangedEvent; /** - * Event fired before a cell becomes active (focus style applied) (cancellable). + * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -45930,7 +45930,7 @@ interface IgGridSelection { activeCellChanging?: ActiveCellChangingEvent; /** - * Event fired after a cell becomes active (focus style applied). + * Event fired after a cell becomes active (focus style applied). * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -45945,7 +45945,7 @@ interface IgGridSelection { activeCellChanged?: ActiveCellChangedEvent; /** - * Event fired before a row becomes active (focus style applied) (cancellable). + * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -45958,7 +45958,7 @@ interface IgGridSelection { activeRowChanging?: ActiveRowChangingEvent; /** - * Event fired after a row becomes active (focus style applied). + * Event fired after a row becomes active (focus style applied). * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -45970,23 +45970,23 @@ interface IgGridSelection { activeRowChanged?: ActiveRowChangedEvent; /** - * Option for igGridSelection + * Option for igGridSelection */ [optionName: string]: any; } interface IgGridSelectionMethods { /** - * Destroys the selection widget. + * Destroys the selection widget. */ destroy(): void; /** - * Clears all selected cells, selected rows, active cell and active row. Also updates the UI accordingly + * Clears all selected cells, selected rows, active cell and active row. Also updates the UI accordingly */ clearSelection(): void; /** - * Selects a cell by row/col + * Selects a cell by row/col * * @param row Row index * @param col Column index @@ -45995,7 +45995,7 @@ interface IgGridSelectionMethods { selectCell(row: number, col: number, isFixed?: boolean): void; /** - * Selects a cell by row id/column key + * Selects a cell by row id/column key * * @param id Row Id * @param colKey Column key @@ -46003,7 +46003,7 @@ interface IgGridSelectionMethods { selectCellById(id: Object, colKey: string): void; /** - * Deselects a cell by row/col + * Deselects a cell by row/col * * @param row Row index * @param col Column index @@ -46012,7 +46012,7 @@ interface IgGridSelectionMethods { deselectCell(row: number, col: number, isFixed?: boolean): void; /** - * Deselects a cell by row id/column key + * Deselects a cell by row id/column key * * @param id Row Id * @param colKey Column key @@ -46020,68 +46020,68 @@ interface IgGridSelectionMethods { deselectCellById(id: Object, colKey: string): void; /** - * Selects a row by index + * Selects a row by index * * @param index Row index */ selectRow(index: number): void; /** - * Selects a row by row id + * Selects a row by row id * * @param id Row Id */ selectRowById(id: Object): void; /** - * Deselects a row by index + * Deselects a row by index * * @param index Row index */ deselectRow(index: number): void; /** - * Deselects a row by row id + * Deselects a row by row id * * @param id Row Id */ deselectRowById(id: Object): void; /** - * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . + * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** - * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . + * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** - * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** - * Returns the currently selected row that has the format { element: , index: }, if any. + * Returns the currently selected row that has the format { element: , index: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedRow(): Object; /** - * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. */ activeCell(): Object; /** - * Returns the currently active (focused) row that has the format { element: , index: }, if any. + * Returns the currently active (focused) row that has the format { element: , index: }, if any. */ activeRow(): Object; } @@ -46091,7 +46091,7 @@ interface JQuery { interface SelectionCollectionSettingsSubscribers { /** - * Option for SelectionCollectionSettingsSubscribers + * Option for SelectionCollectionSettingsSubscribers */ [optionName: string]: any; } @@ -46102,7 +46102,7 @@ interface SelectionCollectionSettings { owner?: any; /** - * Option for SelectionCollectionSettings + * Option for SelectionCollectionSettings */ [optionName: string]: any; } @@ -46629,12 +46629,12 @@ interface ButtonOKClickEvent { interface ButtonOKClickEventUIParam { /** - * Used to get the reference to the igGridModalDialog widget. + * Used to get the reference to the igGridModalDialog widget. */ owner?: any; /** - * Used to get the reference to the igGridModalDialog element + * Used to get the reference to the igGridModalDialog element */ modalDialog?: any; } @@ -46645,12 +46645,12 @@ interface ButtonCancelClickEvent { interface ButtonCancelClickEventUIParam { /** - * Used to get the reference to the igGridModalDialog widget. + * Used to get the reference to the igGridModalDialog widget. */ owner?: any; /** - * Used to get the reference to the igGridModalDialog element + * Used to get the reference to the igGridModalDialog element */ modalDialog?: any; } @@ -46663,12 +46663,12 @@ interface IgGridModalDialog { modalDialogCaptionText?: string; /** - * The default modal dialog width in pixels. + * The default modal dialog width in pixels. */ modalDialogWidth?: number; /** - * The default modal dialog height in pixels. + * The default modal dialog height in pixels. */ modalDialogHeight?: number; renderFooterButtons?: boolean; @@ -46676,17 +46676,17 @@ interface IgGridModalDialog { buttonApplyDisabled?: boolean; /** - * If true and Enter is pressed - close modal dialog(NOTE: buttonApplyDisabled should be set to false - otherwise this options is ignored) + * If true and Enter is pressed - close modal dialog(NOTE: buttonApplyDisabled should be set to false - otherwise this options is ignored) */ closeModalDialogOnEnter?: boolean; /** - * Tab index to assign to containers and buttons inside the dialog + * Tab index to assign to containers and buttons inside the dialog */ tabIndex?: number; /** - * Event fired before the modal dialog is opened. + * Event fired before the modal dialog is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.owner.grid to get the reference to the igGrid widget. @@ -46694,7 +46694,7 @@ interface IgGridModalDialog { modalDialogOpening?: ModalDialogOpeningEvent; /** - * Event fired after the modal dialog is already opened. + * Event fired after the modal dialog is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46702,7 +46702,7 @@ interface IgGridModalDialog { modalDialogOpened?: ModalDialogOpenedEvent; /** - * Event fired every time the modal dialog changes its position. + * Event fired every time the modal dialog changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46712,7 +46712,7 @@ interface IgGridModalDialog { modalDialogMoving?: ModalDialogMovingEvent; /** - * Event fired before the modal dialog is closed. + * Event fired before the modal dialog is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46720,7 +46720,7 @@ interface IgGridModalDialog { modalDialogClosing?: ModalDialogClosingEvent; /** - * Event fired after the modal dialog has been closed. + * Event fired after the modal dialog has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46728,7 +46728,7 @@ interface IgGridModalDialog { modalDialogClosed?: ModalDialogClosedEvent; /** - * Event fired before the contents of the modal dialog are rendered. + * Event fired before the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46736,7 +46736,7 @@ interface IgGridModalDialog { modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** - * Event fired after the contents of the modal dialog are rendered. + * Event fired after the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46744,7 +46744,7 @@ interface IgGridModalDialog { modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** - * Event fired when the button OK/Apply is clicked + * Event fired when the button OK/Apply is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46752,7 +46752,7 @@ interface IgGridModalDialog { buttonOKClick?: ButtonOKClickEvent; /** - * Event fired when the button Cancel is clicked + * Event fired when the button Cancel is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the igGridModalDialog widget. * Use ui.modalDialog to get the reference to the igGridModalDialog element @@ -46760,7 +46760,7 @@ interface IgGridModalDialog { buttonCancelClick?: ButtonCancelClickEvent; /** - * Option for igGridModalDialog + * Option for igGridModalDialog */ [optionName: string]: any; } @@ -46778,7 +46778,7 @@ interface JQuery { interface IgEditorFilter { /** - * Option for igEditorFilter + * Option for igEditorFilter */ [optionName: string]: any; } @@ -47040,7 +47040,7 @@ declare namespace Infragistics { /** * Insert expr at the first position of the se (sorting expressions) if there are not any other expressions with flag group by - * otherwise if there are such expressions inserts after the last + * otherwise if there are such expressions inserts after the last * * @param se * @param expr @@ -47357,19 +47357,19 @@ interface JQuery { } interface IgGridSortingColumnSetting { /** - * Identifies the grid column by key. Either key or index must be set in every column setting. + * Identifies the grid column by key. Either key or index must be set in every column setting. * */ columnKey?: string; /** - * Identifies the grid column by index. Either key or index must be set in every column setting. + * Identifies the grid column by index. Either key or index must be set in every column setting. * */ columnIndex?: number; /** - * This will be the first sort direction when the column hasn't been sorted before. + * This will be the first sort direction when the column hasn't been sorted before. * * * Valid values: @@ -47379,7 +47379,7 @@ interface IgGridSortingColumnSetting { firstSortDirection?: string; /** - * The current (or default) sort direction. If this setting is specified, the column will be rendered sorted according to this option. + * The current (or default) sort direction. If this setting is specified, the column will be rendered sorted according to this option. * * * Valid values: @@ -47389,13 +47389,13 @@ interface IgGridSortingColumnSetting { currentSortDirection?: string; /** - * Enables/disables sorting on the specified column. By default all columns are sortable. + * Enables/disables sorting on the specified column. By default all columns are sortable. * */ allowSorting?: boolean; /** - * Reference to a function (string or function) used for custom comparison. + * Reference to a function (string or function) used for custom comparison. * The function accepts the following arguments: * val1 - the first value to compare, * val2 - the second value to compare, @@ -47413,7 +47413,7 @@ interface IgGridSortingColumnSetting { compareFunc?: string|Function; /** - * Option for IgGridSortingColumnSetting + * Option for IgGridSortingColumnSetting */ [optionName: string]: any; } @@ -47424,22 +47424,22 @@ interface ColumnSortingEvent { interface ColumnSortingEventUIParam { /** - * Used to get reference to GridSorting. + * Used to get reference to GridSorting. */ owner?: any; /** - * Used to get column key. + * Used to get column key. */ columnKey?: any; /** - * Used to get sorting direction. + * Used to get sorting direction. */ direction?: any; /** - * Used to get sorting expressions. + * Used to get sorting expressions. */ newExpressions?: any; } @@ -47450,22 +47450,22 @@ interface ColumnSortedEvent { interface ColumnSortedEventUIParam { /** - * Used to get reference to GridSorting. + * Used to get reference to GridSorting. */ owner?: any; /** - * Used to get column key. + * Used to get column key. */ columnKey?: any; /** - * Used to get sorting direction. + * Used to get sorting direction. */ direction?: any; /** - * Used to get sorted expressions. + * Used to get sorted expressions. */ expressions?: any; } @@ -47476,22 +47476,22 @@ interface ModalDialogSortingChangedEvent { interface ModalDialogSortingChangedEventUIParam { /** - * Used to get the reference to the GridSorting widget. + * Used to get the reference to the GridSorting widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; /** - * Used to get the column key + * Used to get the column key */ columnKey?: any; /** - * Used to get whether column should be ascending or not. If true it should be ascending + * Used to get whether column should be ascending or not. If true it should be ascending */ isAsc?: any; } @@ -47502,17 +47502,17 @@ interface ModalDialogButtonUnsortClickEvent { interface ModalDialogButtonUnsortClickEventUIParam { /** - * Used to get the reference to the GridSorting widget. + * Used to get the reference to the GridSorting widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; /** - * Used to get the column key + * Used to get the column key */ columnKey?: any; } @@ -47523,24 +47523,24 @@ interface ModalDialogSortClickEvent { interface ModalDialogSortClickEventUIParam { /** - * Used to get the reference to the GridSorting widget. + * Used to get the reference to the GridSorting widget. */ owner?: any; /** - * Used to get a reference to the modal dialog element. This is a jQuery object. + * Used to get a reference to the modal dialog element. This is a jQuery object. */ modalDialogElement?: any; /** - * Used to get the column key + * Used to get the column key */ columnKey?: any; } interface IgGridSorting { /** - * Defines local or remote sorting operations. + * Defines local or remote sorting operations. * * * Valid values: @@ -47550,37 +47550,37 @@ interface IgGridSorting { type?: string; /** - * Enables or disables the case sensitivity of the sorting. Works only for [local](ui.iggridsorting#options:type) sorting. + * Enables or disables the case sensitivity of the sorting. Works only for [local](ui.iggridsorting#options:type) sorting. * */ caseSensitive?: boolean; /** - * Enables/disables special styling for sorted columns. If false, sorted column cells will not have any special sort-related styling. + * Enables/disables special styling for sorted columns. If false, sorted column cells will not have any special sort-related styling. * */ applySortedColumnCss?: boolean; /** - * URL param name which specifies how sorting expressions will be encoded in the URL. Uses OData conventions. ex: ?sort(col1)=asc + * URL param name which specifies how sorting expressions will be encoded in the URL. Uses OData conventions. ex: ?sort(col1)=asc * */ sortUrlKey?: string; /** - * URL param value for ascending type of sorting. Uses OData conventions. Example: ?sort(col1)=asc + * URL param value for ascending type of sorting. Uses OData conventions. Example: ?sort(col1)=asc * */ sortUrlKeyAscValue?: string; /** - * URL param value for descending type of sorting. Uses OData conventions. Example: ?sort(col1)=desc + * URL param value for descending type of sorting. Uses OData conventions. Example: ?sort(col1)=desc * */ sortUrlKeyDescValue?: string; /** - * Defines single column sorting or multiple column sorting. + * Defines single column sorting or multiple column sorting. * * * Valid values: @@ -47590,13 +47590,13 @@ interface IgGridSorting { mode?: string; /** - * Custom sort function(or name of the function as a string) accepting three parameters - the data to be sorted, an array of data source field definitions, and the direction to sort with (optional). The function should return the sorted data array. + * Custom sort function(or name of the function as a string) accepting three parameters - the data to be sorted, an array of data source field definitions, and the direction to sort with (optional). The function should return the sorted data array. * */ customSortFunction?: Function; /** - * Specifies which direction to use on the first click / keydown, if the column is sorted for the first time. + * Specifies which direction to use on the first click / keydown, if the column is sorted for the first time. * * * Valid values: @@ -47606,48 +47606,48 @@ interface IgGridSorting { firstSortDirection?: string; /** - * Custom sorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format + * Custom sorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format */ sortedColumnTooltip?: string; /** - * Specifies whether sorting to be applied immediately when click sort/unsort columns when using the multiple sorting dialog. When it is false Apply button shows and sorting is applied when the button is clicked. + * Specifies whether sorting to be applied immediately when click sort/unsort columns when using the multiple sorting dialog. When it is false Apply button shows and sorting is applied when the button is clicked. * */ modalDialogSortOnClick?: boolean; /** - * Specifies sortby button text for each unsorted column in multiple sorting dialog. + * Specifies sortby button text for each unsorted column in multiple sorting dialog. * */ modalDialogSortByButtonText?: string; /** - * Specifies sortby button label for each unsorted column in multiple sorting dialog. + * Specifies sortby button label for each unsorted column in multiple sorting dialog. * */ modalDialogResetButtonLabel?: string; /** - * Specifies caption for each descending sorted column in multiple sorting dialog. + * Specifies caption for each descending sorted column in multiple sorting dialog. * */ modalDialogCaptionButtonDesc?: string; /** - * Specifies caption for each ascending sorted column in multiple sorting dialog. + * Specifies caption for each ascending sorted column in multiple sorting dialog. * */ modalDialogCaptionButtonAsc?: string; /** - * Specifies caption for unsort button in multiple sorting dialog. + * Specifies caption for unsort button in multiple sorting dialog. * */ modalDialogCaptionButtonUnsort?: string; /** - * Specifies width of multiple sorting dialog. + * Specifies width of multiple sorting dialog. * * * Valid values: @@ -47657,7 +47657,7 @@ interface IgGridSorting { modalDialogWidth?: string|number; /** - * Specifies height of multiple sorting dialog. + * Specifies height of multiple sorting dialog. * * * Valid values: @@ -47667,67 +47667,67 @@ interface IgGridSorting { modalDialogHeight?: string|number; /** - * Specifies time of milliseconds for animation duration to show/hide modal dialog. + * Specifies time of milliseconds for animation duration to show/hide modal dialog. * */ modalDialogAnimationDuration?: number; /** - * Specifies the text of the feature chooser sorting button. + * Specifies the text of the feature chooser sorting button. * */ featureChooserText?: string; /** - * Custom unsorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format. + * Custom unsorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format. * */ unsortedColumnTooltip?: string; /** - * A list of custom column settings that specify custom sorting settings for a specific column (whether sorting is enabled / disabled, default sort direction, first sort direction, etc.). + * A list of custom column settings that specify custom sorting settings for a specific column (whether sorting is enabled / disabled, default sort direction, first sort direction, etc.). * */ columnSettings?: IgGridSortingColumnSetting[]; /** - * Specifies caption text for multiple sorting dialog. + * Specifies caption text for multiple sorting dialog. * */ modalDialogCaptionText?: string; /** - * Specifies text of button which apply changes in modal dialog. + * Specifies text of button which apply changes in modal dialog. * */ modalDialogButtonApplyText?: string; /** - * Specifies text of button which cancels the changes in the advanced sorting modal dialog. + * Specifies text of button which cancels the changes in the advanced sorting modal dialog. * */ modalDialogButtonCancelText?: string; /** - * Specifies the text shown in the feature chooser item for sorting in ascending order (displayed only on touch environment). + * Specifies the text shown in the feature chooser item for sorting in ascending order (displayed only on touch environment). * */ featureChooserSortAsc?: string; /** - * Specifies the text shown in the feature chooser item for sorting in descending order (displayed only on touch environment). + * Specifies the text shown in the feature chooser item for sorting in descending order (displayed only on touch environment). * */ featureChooserSortDesc?: string; /** - * Enables/disables sorting persistence when the grid is rebound. + * Enables/disables sorting persistence when the grid is rebound. * */ persist?: boolean; /** - * Controls containment behavior of multiple sorting dialog. + * Controls containment behavior of multiple sorting dialog. * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area @@ -47735,19 +47735,19 @@ interface IgGridSorting { sortingDialogContainment?: string; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before sorting is invoked for a certain column. + * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSorting. @@ -47759,7 +47759,7 @@ interface IgGridSorting { columnSorting?: ColumnSortingEvent; /** - * Event fired after the column has already been sorted and data - re-rendered. + * Event fired after the column has already been sorted and data - re-rendered. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSorting. * Use ui.owner.grid to get reference to grid. @@ -47770,7 +47770,7 @@ interface IgGridSorting { columnSorted?: ColumnSortedEvent; /** - * Event fired before the modal dialog is opened. + * Event fired before the modal dialog is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47779,7 +47779,7 @@ interface IgGridSorting { modalDialogOpening?: ModalDialogOpeningEvent; /** - * Event fired after the modal dialog is already opened. + * Event fired after the modal dialog is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47788,7 +47788,7 @@ interface IgGridSorting { modalDialogOpened?: ModalDialogOpenedEvent; /** - * Event fired every time the modal dialog changes its position. + * Event fired every time the modal dialog changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47799,7 +47799,7 @@ interface IgGridSorting { modalDialogMoving?: ModalDialogMovingEvent; /** - * Event fired before the modal dialog is closed. + * Event fired before the modal dialog is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47808,7 +47808,7 @@ interface IgGridSorting { modalDialogClosing?: ModalDialogClosingEvent; /** - * Event fired after the modal dialog has been closed. + * Event fired after the modal dialog has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47817,7 +47817,7 @@ interface IgGridSorting { modalDialogClosed?: ModalDialogClosedEvent; /** - * Event fired before the contents of the modal dialog are rendered. + * Event fired before the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47826,7 +47826,7 @@ interface IgGridSorting { modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** - * Event fired after the contents of the modal dialog are rendered. + * Event fired after the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47835,7 +47835,7 @@ interface IgGridSorting { modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** - * Event fired when sorting of column is changed in modal dialog. Column should be sorted + * Event fired when sorting of column is changed in modal dialog. Column should be sorted * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47846,7 +47846,7 @@ interface IgGridSorting { modalDialogSortingChanged?: ModalDialogSortingChangedEvent; /** - * Event fired when button to unsort column is clicked in modal dialog + * Event fired when button to unsort column is clicked in modal dialog * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47856,7 +47856,7 @@ interface IgGridSorting { modalDialogButtonUnsortClick?: ModalDialogButtonUnsortClickEvent; /** - * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog + * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47866,7 +47866,7 @@ interface IgGridSorting { modalDialogSortClick?: ModalDialogSortClickEvent; /** - * Event fired when button Apply in modal dialog is clicked + * Event fired when button Apply in modal dialog is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47876,7 +47876,7 @@ interface IgGridSorting { modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** - * Event fired when the button to reset sorting is clicked. + * Event fired when the button to reset sorting is clicked. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -47885,13 +47885,13 @@ interface IgGridSorting { modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; /** - * Option for igGridSorting + * Option for igGridSorting */ [optionName: string]: any; } interface IgGridSortingMethods { /** - * Sorts the data in a grid column and updates the UI. + * Sorts the data in a grid column and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) @@ -47900,17 +47900,17 @@ interface IgGridSortingMethods { sortColumn(index: Object, direction: Object, header: Object): void; /** - * Sorts the data in grid columns and updates the UI.\ + * Sorts the data in grid columns and updates the UI.\ */ sortMultiple(): void; /** - * Removes current sorting(for all sorted columns) and updates the UI. + * Removes current sorting(for all sorted columns) and updates the UI. */ clearSorting(): void; /** - * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. + * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. * @param header - if specified client events should be fired @@ -47918,29 +47918,29 @@ interface IgGridSortingMethods { unsortColumn(index: Object, header: Object): void; /** - * Destroys the sorting feature. Unbinds events, removes added sorting elements, etc. + * Destroys the sorting feature. Unbinds events, removes added sorting elements, etc. */ destroy(): void; /** - * Opens the multiple sorting dialog. + * Opens the multiple sorting dialog. */ openMultipleSortingDialog(): void; /** - * Closes the multiple sorting dialog. + * Closes the multiple sorting dialog. */ closeMultipleSortingDialog(): void; /** - * Renders content of multiple sorting dialog - sorted and unsorted columns. + * Renders content of multiple sorting dialog - sorted and unsorted columns. * * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; /** - * Remove clear button for multiple sorting dialog + * Remove clear button for multiple sorting dialog */ removeDialogClearButton(): void; } @@ -48706,13 +48706,13 @@ interface JQuery { } interface IgGridSummariesColumnSettingSummaryOperand { /** - * Text of the summary method which is shown in summary cell + * Text of the summary method which is shown in summary cell * */ rowDisplayLabel?: string; /** - * Set type of summary operand + * Set type of summary operand * * * Valid values: @@ -48726,68 +48726,68 @@ interface IgGridSummariesColumnSettingSummaryOperand { type?: string; /** - * If it is false the summary operand will be shown in dropdown but it will not be made calculation + * If it is false the summary operand will be shown in dropdown but it will not be made calculation * */ active?: boolean; /** - * Name of the custom summary function which should be executed when type is custom + * Name of the custom summary function which should be executed when type is custom * */ summaryCalculator?: string; /** - * Specifies the order of elements in dropdown. It is recommended to set order of custom operands and to be greater or equal to 5 + * Specifies the order of elements in dropdown. It is recommended to set order of custom operands and to be greater or equal to 5 * */ order?: number; /** - * Specifies the number of digits after the decimal point for result of the current summary operand. This property will be ignored when isGridFormatter is true + * Specifies the number of digits after the decimal point for result of the current summary operand. This property will be ignored when isGridFormatter is true * */ decimalDisplay?: number; /** - * Specifies whether to be used grid formatter for result for the current summary operand. + * Specifies whether to be used grid formatter for result for the current summary operand. * */ isGridFormatter?: boolean; /** - * Option for IgGridSummariesColumnSettingSummaryOperand + * Option for IgGridSummariesColumnSettingSummaryOperand */ [optionName: string]: any; } interface IgGridSummariesColumnSetting { /** - * Enables disables summaries for the column + * Enables disables summaries for the column * */ allowSummaries?: boolean; /** - * Column key. This is a required property in every column setting if columnIndex is not set + * Column key. This is a required property in every column setting if columnIndex is not set * */ columnKey?: string; /** - * Column index. Can be used in place of column key. The preferred way of populating a column setting is to always use the column keys as identifiers + * Column index. Can be used in place of column key. The preferred way of populating a column setting is to always use the column keys as identifiers * */ columnIndex?: number; /** - * Check defaultSummaryOperands + * Check defaultSummaryOperands * */ summaryOperands?: IgGridSummariesColumnSettingSummaryOperand[]; /** - * Option for IgGridSummariesColumnSetting + * Option for IgGridSummariesColumnSetting */ [optionName: string]: any; } @@ -48798,7 +48798,7 @@ interface SummariesCalculatingEvent { interface SummariesCalculatingEventUIParam { /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48809,12 +48809,12 @@ interface SummariesCalculatedEvent { interface SummariesCalculatedEventUIParam { /** - * Used to get data for calculated summaries + * Used to get data for calculated summaries */ data?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48825,22 +48825,22 @@ interface SummariesMethodSelectionChangedEvent { interface SummariesMethodSelectionChangedEventUIParam { /** - * Used to get column key of the column where it is changed selection of summary method + * Used to get column key of the column where it is changed selection of summary method */ columnKey?: any; /** - * Used to get whether method is selected or not + * Used to get whether method is selected or not */ isSelected?: any; /** - * Used to get summary method name + * Used to get summary method name */ methodName?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48851,12 +48851,12 @@ interface SummariesTogglingEvent { interface SummariesTogglingEventUIParam { /** - * Used to get whether summaries are shown or not. + * Used to get whether summaries are shown or not. */ isToShow?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48867,12 +48867,12 @@ interface SummariesToggledEvent { interface SummariesToggledEventUIParam { /** - * Used to get whether summaries are shown or not. + * Used to get whether summaries are shown or not. */ isToShow?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48883,17 +48883,17 @@ interface DropDownOKClickedEvent { interface DropDownOKClickedEventUIParam { /** - * Used to get column key for which OK button is clicked. + * Used to get column key for which OK button is clicked. */ columnKey?: any; /** - * Used to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; + * Used to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; */ eventData?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } @@ -48904,19 +48904,19 @@ interface DropDownCancelClickedEvent { interface DropDownCancelClickedEventUIParam { /** - * Used to get column key for which Cancel button is clicked. + * Used to get column key for which Cancel button is clicked. */ columnKey?: any; /** - * Used to access the igGridSummaries widget object. + * Used to access the igGridSummaries widget object. */ owner?: any; } interface IgGridSummaries { /** - * type of summaries calculating. + * type of summaries calculating. * * * Valid values: @@ -48926,19 +48926,19 @@ interface IgGridSummaries { type?: string; /** - * Text of the button OK in the summaries dropdown + * Text of the button OK in the summaries dropdown * */ dialogButtonOKText?: string; /** - * Text of the button Cancel in the summaries dropdown + * Text of the button Cancel in the summaries dropdown * */ dialogButtonCancelText?: string; /** - * Specifies when calculations are made. + * Specifies when calculations are made. * * * Valid values: @@ -48948,19 +48948,19 @@ interface IgGridSummaries { calculateRenderMode?: string; /** - * Get or set text that is shown in the feature chooser dropdown when summaries are hidden + * Get or set text that is shown in the feature chooser dropdown when summaries are hidden * */ featureChooserText?: string; /** - * Get or set text that is shown in the feauture chooser dropdown when summaries are shown + * Get or set text that is shown in the feauture chooser dropdown when summaries are shown * */ featureChooserTextHide?: string; /** - * Specifies how compact the summaries are rendered. + * Specifies how compact the summaries are rendered. * When true indicates that the summaries may be rendered compactly, even mixing different summaries on the same line. * False ensures that each summary type is occupying a separate line. * Auto will use True if the maximum number of visible summaries is one or less and False otherwise. @@ -48969,55 +48969,55 @@ interface IgGridSummaries { compactRenderingMode?: any; /** - * The number of digits after the decimal point. If gridFormatter is True then this option is ignored. + * The number of digits after the decimal point. If gridFormatter is True then this option is ignored. * */ defaultDecimalDisplay?: number; /** - * Show header button icon in the header cell. On click - shows/hides summaries. If false then summary icon should not be shown in the feature chooser(if shown). + * Show header button icon in the header cell. On click - shows/hides summaries. If false then summary icon should not be shown in the feature chooser(if shown). * */ showSummariesButton?: boolean; /** - * Result key by which we get data from the result returned by remote data source. + * Result key by which we get data from the result returned by remote data source. * */ summariesResponseKey?: string; /** - * Set key in GET Request for summaries - used only when type is remote + * Set key in GET Request for summaries - used only when type is remote * */ summaryExprUrlKey?: string; /** - * Function reference - it is called when data is retrieved from the data source + * Function reference - it is called when data is retrieved from the data source * */ callee?: Function; /** - * Height of the dropdown in pixels + * Height of the dropdown in pixels * */ dropDownHeight?: number; /** - * Width of the dropdown in pixels + * Width of the dropdown in pixels * */ dropDownWidth?: number; /** - * Show/hide footer button(on click show/hide dropdown) + * Show/hide footer button(on click show/hide dropdown) * */ showDropDownButton?: boolean; /** - * Determines when the summary values are calculated when type is local + * Determines when the summary values are calculated when type is local * * * Valid values: @@ -49028,54 +49028,54 @@ interface IgGridSummaries { summaryExecution?: string; /** - * Dropdown animation duration + * Dropdown animation duration * */ dropDownDialogAnimationDuration?: number; /** - * Empty text template to be shown for empty cells + * Empty text template to be shown for empty cells * */ emptyCellText?: string; /** - * Tooltip text for header cell button + * Tooltip text for header cell button * */ summariesHeaderButtonTooltip?: string; /** - * Result template for summary result(shown in table cell) + * Result template for summary result(shown in table cell) * */ resultTemplate?: string; /** - * If this property is enabled and in summaryOperand isGridFormatter is undefined then use grid formatting for cells + * If this property is enabled and in summaryOperand isGridFormatter is undefined then use grid formatting for cells * */ isGridFormatter?: boolean; /** - * a reference or name of a javascript function - renders summary cell in grid footer.(if not set it is used default render function) It takes 3 parameters - methodName(summary method), columnKey, data(summary data which should be rendered) + * a reference or name of a javascript function - renders summary cell in grid footer.(if not set it is used default render function) It takes 3 parameters - methodName(summary method), columnKey, data(summary data which should be rendered) * */ renderSummaryCellFunc?: string|Object; /** - * A list of column settings that specifies custom summaries options per column basis + * A list of column settings that specifies custom summaries options per column basis * */ columnSettings?: IgGridSummariesColumnSetting[]; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before drop down is opened for a specific column summary + * Event fired before drop down is opened for a specific column summary * Return false in order to cancel opening the drop down. * Function takes arguments evt and ui. * Use ui.columnKey to get column key of the column where drop down is opening. @@ -49084,7 +49084,7 @@ interface IgGridSummaries { dropDownOpening?: DropDownOpeningEvent; /** - * Event fired after the summaries dropdown is opened for a specific column + * Event fired after the summaries dropdown is opened for a specific column * Function takes arguments evt and ui. * Use ui.columnKey to get column key of the column where drop down is shown. * Use ui.owner in order to access the igGridSummaries widget object. @@ -49092,7 +49092,7 @@ interface IgGridSummaries { dropDownOpened?: DropDownOpenedEvent; /** - * Event fired before the dropdown for a summary column starts closing + * Event fired before the dropdown for a summary column starts closing * Return false in order to cancel closing the drop down. * Function takes arguments evt and ui. * Use ui.columnKey to get column key of the column where drop down is closing. @@ -49101,7 +49101,7 @@ interface IgGridSummaries { dropDownClosing?: DropDownClosingEvent; /** - * Event fired after the dropdown for a summary column is closed + * Event fired after the dropdown for a summary column is closed * Function takes arguments evt and ui. * Use ui.columnKey to get column key of the column where drop down is closing. * Use ui.owner in order to access the igGridSummaries widget object. @@ -49109,7 +49109,7 @@ interface IgGridSummaries { dropDownClosed?: DropDownClosedEvent; /** - * Event fired before summaries calculations are made + * Event fired before summaries calculations are made * Return false in order to cancel calculation of summaries. * Function takes arguments evt and ui. * Use ui.owner in order to access the igGridSummaries widget object. @@ -49117,7 +49117,7 @@ interface IgGridSummaries { summariesCalculating?: SummariesCalculatingEvent; /** - * Event fired after summaries calculation are completely made + * Event fired after summaries calculation are completely made * Function takes arguments evt and ui. * Use ui.data to get data for calculated summaries * Use ui.owner in order to access the igGridSummaries widget object. @@ -49125,7 +49125,7 @@ interface IgGridSummaries { summariesCalculated?: SummariesCalculatedEvent; /** - * Event fired when user selects/deselects summary method from checkbox + * Event fired when user selects/deselects summary method from checkbox * Function takes arguments evt and ui. * Use ui.columnKey to get column key of the column where it is changed selection of summary method * Use ui.isSelected to get whether method is selected or not @@ -49135,7 +49135,7 @@ interface IgGridSummaries { summariesMethodSelectionChanged?: SummariesMethodSelectionChangedEvent; /** - * Event is fired bofore summary rows start toggling + * Event is fired bofore summary rows start toggling * Return false in order to cancel showing/hiding of summaries. * Function takes arguments evt and ui. * Use ui.isToShow to get whether summaries are shown or not. @@ -49144,7 +49144,7 @@ interface IgGridSummaries { summariesToggling?: SummariesTogglingEvent; /** - * Event is fired after summary rows are toggled + * Event is fired after summary rows are toggled * Function takes arguments evt and ui. * Use ui.isToShow to get whether summaries are shown or not. * Use ui.owner in order to access the igGridSummaries widget object. @@ -49152,7 +49152,7 @@ interface IgGridSummaries { summariesToggled?: SummariesToggledEvent; /** - * Event is fired when OK button is clicked in drop down + * Event is fired when OK button is clicked in drop down * Function takes arguments evt and ui. * Use ui.columnKey to get column key for which OK button is clicked. * Use ui.eventData to get data about which summary methods are(not) selected. Format of event data is {type: "min", active: false}; @@ -49161,7 +49161,7 @@ interface IgGridSummaries { dropDownOKClicked?: DropDownOKClickedEvent; /** - * Event is fired when Cancel button is clicked in drop down. + * Event is fired when Cancel button is clicked in drop down. * Function takes arguments evt and ui. * Use ui.columnKey to get column key for which Cancel button is clicked. * Use ui.owner in order to access the igGridSummaries widget object. @@ -49169,7 +49169,7 @@ interface IgGridSummaries { dropDownCancelClicked?: DropDownCancelClickedEvent; /** - * Option for igGridSummaries + * Option for igGridSummaries */ [optionName: string]: any; } @@ -49177,22 +49177,22 @@ interface IgGridSummariesMethods { destroy(): void; /** - * Returns whether summaries rows are hidden + * Returns whether summaries rows are hidden */ isSummariesRowsHidden(): void; /** - * Calculate summaries + * Calculate summaries */ calculateSummaries(): void; /** - * Remove all summaries dropdown buttons. + * Remove all summaries dropdown buttons. */ clearAllFooterIcons(): void; /** - * Toggle drop down + * Toggle drop down * * @param columnKey toggle drop down for the column with the specified key * @param event event object. Its data should contain current columnKey, isAnimating, buttonId @@ -49200,14 +49200,14 @@ interface IgGridSummariesMethods { toggleDropDown(columnKey: string, event: Object): void; /** - * Show/Hide dialog + * Show/Hide dialog * * @param $dialog jQuery object representation of dropdown div element */ showHideDialog($dialog: Object): void; /** - * Toggle summaries rows + * Toggle summaries rows * * @param isToShow Specifies whether to show or not summaries * @param isInternalCall Optional parameter.Specifies whether this function is called internally by the widget. @@ -49215,14 +49215,14 @@ interface IgGridSummariesMethods { toggleSummariesRows(isToShow: boolean, isInternalCall: boolean): void; /** - * Toggles the checkstate of a checkbox if checkboxMode is not set to off, otherwise does nothing. + * Toggles the checkstate of a checkbox if checkboxMode is not set to off, otherwise does nothing. * * @param $checkbox Specifies the jQuery object of the checkbox. */ toggleCheckstate($checkbox: Object): void; /** - * Select/Unselect specified checkbox + * Select/Unselect specified checkbox * * @param $checkbox Specifies the jQuery object for checkbox * @param isToSelect Specify whether to select or not checkbox @@ -49230,23 +49230,23 @@ interface IgGridSummariesMethods { selectCheckBox($checkbox: Object, isToSelect: boolean): void; /** - * Summary calculate the whole data for the specified column key, columnMethods and dataType (used when datasource is remote and dataType is date) + * Summary calculate the whole data for the specified column key, columnMethods and dataType (used when datasource is remote and dataType is date) * * @param ck ColumnKey * @param columnMethods Array of column methods objects * @param data Object which represents result - represents dataType for the current column + * represents dataType for the current column * @param dataType */ calculateSummaryColumn(ck: string, columnMethods: any[], data: Object, dataType: Object): void; /** - * Return a JQUERY object which holds all summaries for all columns + * Return a JQUERY object which holds all summaries for all columns */ summaryCollection(): void; /** - * Return a JQUERY object which holds all summaries for column with the specified column key + * Return a JQUERY object which holds all summaries for column with the specified column key * * @param columnKey */ @@ -49827,38 +49827,38 @@ interface JQuery { } interface IgGridTooltipsColumnSettings { /** - * Either key or index must be set in every column setting. + * Either key or index must be set in every column setting. * */ columnKey?: string; /** - * Either key or index must be set in every column setting. + * Either key or index must be set in every column setting. * */ columnIndex?: number; /** - * Enables / disables tooltips on the specified column. By default tooltips are displayed for each column. Note: This option is mandatory. + * Enables / disables tooltips on the specified column. By default tooltips are displayed for each column. Note: This option is mandatory. * */ allowTooltips?: boolean; /** - * Specifies the maximum width (in pixels) of the tooltip when shown for the specified column. If unset the width of the column will be used instead. + * Specifies the maximum width (in pixels) of the tooltip when shown for the specified column. If unset the width of the column will be used instead. * */ maxWidth?: number; /** - * Option for IgGridTooltipsColumnSettings + * Option for IgGridTooltipsColumnSettings */ [optionName: string]: any; } interface IgGridTooltips { /** - * determines the tooltip visibility option + * determines the tooltip visibility option * * * Valid values: @@ -49869,7 +49869,7 @@ interface IgGridTooltips { visibility?: string; /** - * controls the tooltip's style + * controls the tooltip's style * * * Valid values: @@ -49879,50 +49879,50 @@ interface IgGridTooltips { style?: string; /** - * The time in milliseconds after which tooltip will show when + * The time in milliseconds after which tooltip will show when * mouse cursor is hovered over a cell. * */ showDelay?: number; /** - * Type="integer" The time in milliseconds after which tooltip hides when mouse + * Type="integer" The time in milliseconds after which tooltip hides when mouse * cursor gets outside of the cell. * */ hideDelay?: number; /** - * A list of custom column settings that specify custom tooltip settings for a specific column (whether tooltips are enabled / disabled) + * A list of custom column settings that specify custom tooltip settings for a specific column (whether tooltips are enabled / disabled) * */ columnSettings?: IgGridTooltipsColumnSettings; /** - * Sets the time tooltip fades in and out when showing/hiding + * Sets the time tooltip fades in and out when showing/hiding * */ fadeTimespan?: number; /** - * Sets the left position of the tooltip relative to the mouse cursor + * Sets the left position of the tooltip relative to the mouse cursor * */ cursorLeftOffset?: number; /** - * Sets the top position of the tooltip relative to the mouse cursor + * Sets the top position of the tooltip relative to the mouse cursor * */ cursorTopOffset?: number; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired when the mouse has hovered on an element long enough to display a tooltip + * Event fired when the mouse has hovered on an element long enough to display a tooltip * use args.owner to get a reference to the widget * use args.tooltip to get or set the string to be displayed * use args.value to get the value of the cell the tooltip is displayed for @@ -49934,7 +49934,7 @@ interface IgGridTooltips { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip is displayed for @@ -49946,7 +49946,7 @@ interface IgGridTooltips { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left an element and the tooltip is about to hide + * Event fired when the mouse has left an element and the tooltip is about to hide * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip is displayed for @@ -49958,7 +49958,7 @@ interface IgGridTooltips { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip was displayed for @@ -49970,18 +49970,18 @@ interface IgGridTooltips { tooltipHidden?: TooltipHiddenEvent; /** - * Option for igGridTooltips + * Option for igGridTooltips */ [optionName: string]: any; } interface IgGridTooltipsMethods { /** - * Destroys the tooltip widget. + * Destroys the tooltip widget. */ destroy(): void; /** - * Returns the ID of the parent div element bounding the ruler and the tooltip container + * Returns the ID of the parent div element bounding the ruler and the tooltip container */ id(): string; } @@ -50232,13 +50232,13 @@ interface JQuery { } interface IgGridUpdatingColumnSetting { /** - * Identifies the grid column by key. + * Identifies the grid column by key. * */ columnKey?: string; /** - * Specifies the type of editor to use for the column. + * Specifies the type of editor to use for the column. * * * Valid values: @@ -50256,7 +50256,7 @@ interface IgGridUpdatingColumnSetting { editorType?: string; /** - * Specifies а custom editor provider instance. More information about editor providers can be found [here](http://www.igniteui.com/help/implementing-custom-editor-provider) and [here](http://www.igniteui.com/help/working-with-combo-editor-provider). + * Specifies а custom editor provider instance. More information about editor providers can be found [here](http://www.igniteui.com/help/implementing-custom-editor-provider) and [here](http://www.igniteui.com/help/working-with-combo-editor-provider). * It should either extend $.ig.EditorProvider or have definitions for the following methods: * $.ig.EditorProvider = $.ig.EditorProvider|| $.ig.EditorProvider.extend({ * createEditor: function (callbacks, key, editorOptions, tabIndex, format, element) {}, @@ -50278,50 +50278,50 @@ interface IgGridUpdatingColumnSetting { editorProvider?: any; /** - * Specifies options to initialize the corresponding editor with. + * Specifies options to initialize the corresponding editor with. * */ editorOptions?: any; /** - * Specifies if the end-user will be allowed to leave the editor's value empty during edit mode or not. + * Specifies if the end-user will be allowed to leave the editor's value empty during edit mode or not. * */ required?: boolean; /** - * Specifies if the column is read-only. In 'cell' and 'row' [editMode](ui.iggridupdating#options:editMode) no editor will be created for read-only columns. In 'dialog' mode enabling [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) will display disabled editors for such columns. + * Specifies if the column is read-only. In 'cell' and 'row' [editMode](ui.iggridupdating#options:editMode) no editor will be created for read-only columns. In 'dialog' mode enabling [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) will display disabled editors for such columns. * */ readOnly?: boolean; /** - * Specifies if the column's value should be validated or not. The validation is done based on the rules of the corresponding editor. + * Specifies if the column's value should be validated or not. The validation is done based on the rules of the corresponding editor. * */ validation?: boolean; /** - * Specifies the default value for the column when adding new rows. When in edit mode for adding a row the value will be pre-filled in the column's editor (if the column is not read-only). The value should be of the type specified for the column in the grid's [columns](ui.iggrid#options:columns) collection. + * Specifies the default value for the column when adding new rows. When in edit mode for adding a row the value will be pre-filled in the column's editor (if the column is not read-only). The value should be of the type specified for the column in the grid's [columns](ui.iggrid#options:columns) collection. * */ defaultValue?: any; /** - * Option for IgGridUpdatingColumnSetting + * Option for IgGridUpdatingColumnSetting */ [optionName: string]: any; } interface IgGridUpdatingRowEditDialogOptions { /** - * Specifies the caption of the dialog. If not set, $.ig.GridUpdating.locale.rowEditDialogCaptionLabel is used. + * Specifies the caption of the dialog. If not set, $.ig.GridUpdating.locale.rowEditDialogCaptionLabel is used. * */ captionLabel?: string; /** - * Controls the containment of the dialog's drag operation. + * Controls the containment of the dialog's drag operation. * * * Valid values: @@ -50331,7 +50331,7 @@ interface IgGridUpdatingRowEditDialogOptions { containment?: string; /** - * Controls the default row edit dialog width. + * Controls the default row edit dialog width. * * * Valid values: @@ -50341,7 +50341,7 @@ interface IgGridUpdatingRowEditDialogOptions { width?: string|number; /** - * Controls the default row edit dialog height. + * Controls the default row edit dialog height. * * * Valid values: @@ -50351,25 +50351,25 @@ interface IgGridUpdatingRowEditDialogOptions { height?: string|number; /** - * Specifies the animation duration for the opening and closing operations. + * Specifies the animation duration for the opening and closing operations. * */ animationDuration?: number; /** - * Controls if editors should be rendered for read-only columns. If rendered, these editors will be disabled. + * Controls if editors should be rendered for read-only columns. If rendered, these editors will be disabled. * */ showReadonlyEditors?: boolean; /** - * Controls if editors should be rendered for hidden columns. + * Controls if editors should be rendered for hidden columns. * */ showEditorsForHiddenColumns?: boolean; /** - * Controls the width of the column containing the column names in the default row edit dialog. + * Controls the width of the column containing the column names in the default row edit dialog. * * * Valid values: @@ -50380,7 +50380,7 @@ interface IgGridUpdatingRowEditDialogOptions { namesColumnWidth?: string|number; /** - * Controls the width of the column containing the editors in the default row edit dialog. + * Controls the width of the column containing the editors in the default row edit dialog. * * * Valid values: @@ -50391,42 +50391,42 @@ interface IgGridUpdatingRowEditDialogOptions { editorsColumnWidth?: string|number; /** - * Controls the visibility of the done and cancel buttons for the dialog. + * Controls the visibility of the done and cancel buttons for the dialog. * If disabled the end-user will be able to stop editing only with the Enter and Esc keys. * */ showDoneCancelButtons?: boolean; /** - * Specifies a template to be rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both dialogTemplate and [dialogTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplateSelector) are specified, dialogTemplateSelector will be used.The default template is '
'. + * Specifies a template to be rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both dialogTemplate and [dialogTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplateSelector) are specified, dialogTemplateSelector will be used.The default template is '
'. * * */ dialogTemplate?: string; /** - * Specifies a selector to a template rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) and dialogTemplateSelector are specified, dialogTemplateSelector will be used.The default template is '
'. + * Specifies a selector to a template rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) and dialogTemplateSelector are specified, dialogTemplateSelector will be used.The default template is '
'. * * */ dialogTemplateSelector?: string; /** - * Specifies a template to be executed for each column in the grid's column collection (or just the read-write columns if [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) is false). Decorate the element to be used as an editor with 'data-editor-for-${key}'. The ${key} template tag should be replaced with the chosen templating engine's syntax for rendering values. If any editors for columns are specified in the dialog markup they will be exluded from the data the template will be rendered for. This property is ignored if [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) does not include an element with the 'data-render-tmpl' attribute. If both editorsTemplate and [editorsTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplateSelector) are specified, editorsTemplateSelector will be used. + * Specifies a template to be executed for each column in the grid's column collection (or just the read-write columns if [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) is false). Decorate the element to be used as an editor with 'data-editor-for-${key}'. The ${key} template tag should be replaced with the chosen templating engine's syntax for rendering values. If any editors for columns are specified in the dialog markup they will be exluded from the data the template will be rendered for. This property is ignored if [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) does not include an element with the 'data-render-tmpl' attribute. If both editorsTemplate and [editorsTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplateSelector) are specified, editorsTemplateSelector will be used. * The default template is '${headerText}' * */ editorsTemplate?: string; /** - * Specifies a selector to a template to be executed for each column in the grid's column collection (or just the read-write columns if [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) is false). Decorate the element to be used as an editor with 'data-editor-for-${key}'. The ${key} template tag should be replaced with the chosen templating engine's syntax for rendering values. If any editors for columns are specified in the dialog markup they will be exluded from the data the template will be rendered for. This property is ignored if [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) does not include an element with the 'data-render-tmpl' attribute. If both [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) and editorsTemplateSelector are specified, editorsTemplateSelector will be used. + * Specifies a selector to a template to be executed for each column in the grid's column collection (or just the read-write columns if [showReadonlyEditors](ui.iggridupdating#options:rowEditDialogOptions.showReadonlyEditors) is false). Decorate the element to be used as an editor with 'data-editor-for-${key}'. The ${key} template tag should be replaced with the chosen templating engine's syntax for rendering values. If any editors for columns are specified in the dialog markup they will be exluded from the data the template will be rendered for. This property is ignored if [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) does not include an element with the 'data-render-tmpl' attribute. If both [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) and editorsTemplateSelector are specified, editorsTemplateSelector will be used. * The default template is '${headerText}' * */ editorsTemplateSelector?: string; /** - * Option for IgGridUpdatingRowEditDialogOptions + * Option for IgGridUpdatingRowEditDialogOptions */ [optionName: string]: any; } @@ -50437,17 +50437,17 @@ interface EditRowStartingEvent { interface EditRowStartingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50458,17 +50458,17 @@ interface EditRowStartedEvent { interface EditRowStartedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50479,32 +50479,32 @@ interface EditRowEndingEvent { interface EditRowEndingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. + * Used to check if any of the values is changed which will cause update in the data source. Can be manually set to false to prevent this update. */ update?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; /** - * Used to get or set the new value for the column with the specified key. + * Used to get or set the new value for the column with the specified key. */ values?: any; /** - * Used to get the old value for the column with the specified key. + * Used to get the old value for the column with the specified key. */ oldValues?: any; } @@ -50515,32 +50515,32 @@ interface EditRowEndedEvent { interface EditRowEndedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to check if any of the values is changed which will cause update in the data source. + * Used to check if any of the values is changed which will cause update in the data source. */ update?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; /** - * Used to get the new value for the column with the specified key. + * Used to get the new value for the column with the specified key. */ values?: any; /** - * Used to get the old value for the column with the specified key. + * Used to get the old value for the column with the specified key. */ oldValues?: any; } @@ -50551,37 +50551,37 @@ interface EditCellStartingEvent { interface EditCellStartingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to get the index of the column. + * Used to get the index of the column. */ columnIndex?: any; /** - * Used to get the key of the column. + * Used to get the key of the column. */ columnKey?: any; /** - * Used tor to get a reference to the editor used for editing the column. + * Used tor to get a reference to the editor used for editing the column. */ editor?: any; /** - * Used to get or set the value of the editor. + * Used to get or set the value of the editor. */ value?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50592,37 +50592,37 @@ interface EditCellStartedEvent { interface EditCellStartedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to get the index of the column. + * Used to get the index of the column. */ columnIndex?: any; /** - * Used to get the key of the column. + * Used to get the key of the column. */ columnKey?: any; /** - * Used tor to get a reference to the editor used for editing the column. + * Used tor to get a reference to the editor used for editing the column. */ editor?: any; /** - * Used to get the value of the editor. + * Used to get the value of the editor. */ value?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50633,47 +50633,47 @@ interface EditCellEndingEvent { interface EditCellEndingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to get the index of the column. + * Used to get the index of the column. */ columnIndex?: any; /** - * Used to get the key of the column. + * Used to get the key of the column. */ columnKey?: any; /** - * Used tor to get a reference to the editor used for editing the column. + * Used tor to get a reference to the editor used for editing the column. */ editor?: any; /** - * Used to get or set the value to be used when updating the data source. + * Used to get or set the value to be used when updating the data source. */ value?: any; /** - * Used to get the old value. + * Used to get the old value. */ oldValue?: any; /** - * Used to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. + * Used to check if the value is changed which will cause update in the data source. Can be manually set to false to prevent this update. */ update?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50684,47 +50684,47 @@ interface EditCellEndedEvent { interface EditCellEndedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; /** - * Used to get the index of the column. + * Used to get the index of the column. */ columnIndex?: any; /** - * Used to get the key of the column. + * Used to get the key of the column. */ columnKey?: any; /** - * Used tor to get a reference to the editor used for editing the column. + * Used tor to get a reference to the editor used for editing the column. */ editor?: any; /** - * Used to get the new value. + * Used to get the new value. */ value?: any; /** - * Used to get the old value. + * Used to get the old value. */ oldValue?: any; /** - * Used to check if the value is changed which will cause update in the data source. + * Used to check if the value is changed which will cause update in the data source. */ update?: any; /** - * Used to check if the edit mode is for adding a new row. + * Used to check if the edit mode is for adding a new row. */ rowAdding?: any; } @@ -50735,17 +50735,17 @@ interface RowAddingEvent { interface RowAddingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the value for the column with the specified key. + * Used to get the value for the column with the specified key. */ values?: any; /** - * Used to get the default value (before editing) for the column with the specified key. + * Used to get the default value (before editing) for the column with the specified key. */ oldValues?: any; } @@ -50756,17 +50756,17 @@ interface RowAddedEvent { interface RowAddedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the value for the column with the specified key. + * Used to get the value for the column with the specified key. */ values?: any; /** - * Used to get the default value (before editing) for the column with the specified key. + * Used to get the default value (before editing) for the column with the specified key. */ oldValues?: any; } @@ -50777,17 +50777,17 @@ interface RowDeletingEvent { interface RowDeletingEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get a jQuery object containing the TR element of the row to delete. + * Used to get a jQuery object containing the TR element of the row to delete. */ element?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; } @@ -50798,17 +50798,17 @@ interface RowDeletedEvent { interface RowDeletedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get a jQuery object containing the TR element of the deleted row. + * Used to get a jQuery object containing the TR element of the deleted row. */ element?: any; /** - * Used to get the row's PK value. + * Used to get the row's PK value. */ rowID?: any; } @@ -50819,7 +50819,7 @@ interface DataDirtyEvent { interface DataDirtyEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; } @@ -50830,12 +50830,12 @@ interface GeneratePrimaryKeyValueEvent { interface GeneratePrimaryKeyValueEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. + * Used to get the auto-generated primary key (the number of records in the data source + 1) or set a custom unique primary key for the new row. */ value?: any; } @@ -50846,12 +50846,12 @@ interface RowEditDialogBeforeOpenEvent { interface RowEditDialogBeforeOpenEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get reference to row edit dialog DOM element. + * Used to get reference to row edit dialog DOM element. */ dialogElement?: any; } @@ -50862,12 +50862,12 @@ interface RowEditDialogAfterOpenEvent { interface RowEditDialogAfterOpenEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get reference to row edit dialog DOM element. + * Used to get reference to row edit dialog DOM element. */ dialogElement?: any; } @@ -50878,12 +50878,12 @@ interface RowEditDialogBeforeCloseEvent { interface RowEditDialogBeforeCloseEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get reference to row edit dialog DOM element. + * Used to get reference to row edit dialog DOM element. */ dialogElement?: any; } @@ -50894,12 +50894,12 @@ interface RowEditDialogAfterCloseEvent { interface RowEditDialogAfterCloseEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get reference to row edit dialog DOM element. + * Used to get reference to row edit dialog DOM element. */ dialogElement?: any; } @@ -50910,25 +50910,25 @@ interface RowEditDialogContentsRenderedEvent { interface RowEditDialogContentsRenderedEventUIParam { /** - * Used to get a reference to GridUpdating. + * Used to get a reference to GridUpdating. */ owner?: any; /** - * Used to get reference to row edit dialog DOM element. + * Used to get reference to row edit dialog DOM element. */ dialogElement?: any; } interface IgGridUpdating { /** - * A list of custom column options that specify editing and validation settings for a specific column. + * A list of custom column options that specify editing and validation settings for a specific column. * */ columnSettings?: IgGridUpdatingColumnSetting[]; /** - * Specifies the edit mode. + * Specifies the edit mode. * * * Valid values: @@ -50940,144 +50940,144 @@ interface IgGridUpdating { editMode?: string; /** - * Specifies if deleting rows through the UI is enabled. + * Specifies if deleting rows through the UI is enabled. * */ enableDeleteRow?: boolean; /** - * Specifies if adding rows through the UI is enabled. When enabled an additional row is rendered at the bottom of the grid's header that works as a button. When the end-user clicks on it edit mode is initiated either through a dialog (when [editMode](ui.iggridupdating#options:editMode) is 'dialog') or mimicking the look and feel of 'row' [editMode](ui.iggridupdating#options:editMode) (when [editMode](ui.iggridupdating#options:editMode) is 'row' or 'cell'). + * Specifies if adding rows through the UI is enabled. When enabled an additional row is rendered at the bottom of the grid's header that works as a button. When the end-user clicks on it edit mode is initiated either through a dialog (when [editMode](ui.iggridupdating#options:editMode) is 'dialog') or mimicking the look and feel of 'row' [editMode](ui.iggridupdating#options:editMode) (when [editMode](ui.iggridupdating#options:editMode) is 'row' or 'cell'). * */ enableAddRow?: boolean; /** - * Specifies if the value of each editable column in the grid should be validated. The validation is done based on the rules of their corresponding editors. + * Specifies if the value of each editable column in the grid should be validated. The validation is done based on the rules of their corresponding editors. * */ validation?: boolean; /** - * Specifies the label for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneLabel is used. + * Specifies the label for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneLabel is used. * */ doneLabel?: string; /** - * Specifies the title for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneTooltip is used. + * Specifies the title for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneTooltip is used. * */ doneTooltip?: string; /** - * Specifies the label for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelLabel is used. + * Specifies the label for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelLabel is used. * */ cancelLabel?: string; /** - * Specifies the title for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelTooltip is used. + * Specifies the title for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelTooltip is used. * */ cancelTooltip?: string; /** - * Specifies the label for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowLabel is used. + * Specifies the label for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowLabel is used. * */ addRowLabel?: string; /** - * Specifies the title for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowTooltip is used. + * Specifies the title for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowTooltip is used. * */ addRowTooltip?: string; /** - * Specifies the label for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowLabel is used. + * Specifies the label for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowLabel is used. * */ deleteRowLabel?: string; /** - * Specifies the title for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowTooltip is used. + * Specifies the title for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowTooltip is used. * */ deleteRowTooltip?: string; /** - * Determines if the Done and Cancel buttons will be available as means to end edit mode for [editMode](ui.iggridupdating#options:editMode) 'row' and when adding a new row. + * Determines if the Done and Cancel buttons will be available as means to end edit mode for [editMode](ui.iggridupdating#options:editMode) 'row' and when adding a new row. * */ showDoneCancelButtons?: boolean; /** - * Specifies if an exception should be thrown when the grid's data view changes while there are pending transactions in the data source. The data view changes when the data source performs a sorting, filtering, groupby or paging operation and the exception thrown will prevent the operation from succeeding. All pending transactions must be committed before a data view operation is able to complete. Committing transactions can be done manually through the grid's [commit](ui.iggrid#methods:commit) function or automatically by setting [autoCommit](ui.iggrid#options:autoCommit) to 'true'. + * Specifies if an exception should be thrown when the grid's data view changes while there are pending transactions in the data source. The data view changes when the data source performs a sorting, filtering, groupby or paging operation and the exception thrown will prevent the operation from succeeding. All pending transactions must be committed before a data view operation is able to complete. Committing transactions can be done manually through the grid's [commit](ui.iggrid#methods:commit) function or automatically by setting [autoCommit](ui.iggrid#options:autoCommit) to 'true'. * */ enableDataDirtyException?: boolean; /** - * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. + * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. * */ startEditTriggers?: string|Array; /** - * Determines if pressing Enter to navigate away from the currently edited cell should move the focus horizontally or vertically (default). + * Determines if pressing Enter to navigate away from the currently edited cell should move the focus horizontally or vertically (default). * */ horizontalMoveOnEnter?: boolean; /** - * Enables excel navigation style. When turned on, the arrow keys can be used for changing the currently edited cell similar to how Tab and Enter behave. When disabled, the arrow keys control the cursor inside editors. + * Enables excel navigation style. When turned on, the arrow keys can be used for changing the currently edited cell similar to how Tab and Enter behave. When disabled, the arrow keys control the cursor inside editors. * */ excelNavigationMode?: boolean; /** - * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. + * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. * */ saveChangesSuccessHandler?: Function|string; /** - * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. + * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. * */ saveChangesErrorHandler?: Function|string; /** - * On touch-enabled devices specifies the swipe distance for the delete button to appear. + * On touch-enabled devices specifies the swipe distance for the delete button to appear. * */ swipeDistance?: string|number; /** - * Controls if navigation will wrap around the grid. The feature will never wrap around virtual grids. + * Controls if navigation will wrap around the grid. The feature will never wrap around virtual grids. * */ wrapAround?: boolean; /** - * A list of options controlling the rendering behavior of the row edit dialog. If [editMode](ui.iggridupdating#options:editMode) is not 'dialog' these have no effect. + * A list of options controlling the rendering behavior of the row edit dialog. If [editMode](ui.iggridupdating#options:editMode) is not 'dialog' these have no effect. * */ rowEditDialogOptions?: IgGridUpdatingRowEditDialogOptions; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. For more information on how to utilize this property, please refer to the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. For more information on how to utilize this property, please refer to the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts in igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts in igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before row editing begins. + * Event fired before row editing begins. * Return false in order to cancel editing. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51088,7 +51088,7 @@ interface IgGridUpdating { editRowStarting?: EditRowStartingEvent; /** - * Event fired after row editing begins. + * Event fired after row editing begins. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51098,7 +51098,7 @@ interface IgGridUpdating { editRowStarted?: EditRowStartedEvent; /** - * Event fired before row editing ends. + * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51112,7 +51112,7 @@ interface IgGridUpdating { editRowEnding?: EditRowEndingEvent; /** - * Event fired after row editing ends. + * Event fired after row editing ends. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51125,7 +51125,7 @@ interface IgGridUpdating { editRowEnded?: EditRowEndedEvent; /** - * Event fired before cell editing begins (including when row editing opens editing for a cell). + * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51140,7 +51140,7 @@ interface IgGridUpdating { editCellStarting?: EditCellStartingEvent; /** - * Event fired after cell editing begins (including when row editing opens editing for a cell). + * Event fired after cell editing begins (including when row editing opens editing for a cell). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51154,7 +51154,7 @@ interface IgGridUpdating { editCellStarted?: EditCellStartedEvent; /** - * Event fired before cell editing ends (including when row editing closes editing for a cell). + * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51171,7 +51171,7 @@ interface IgGridUpdating { editCellEnding?: EditCellEndingEvent; /** - * Event fired after cell editing ends (including when row editing closes editing for a cell). + * Event fired after cell editing ends (including when row editing closes editing for a cell). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51187,7 +51187,7 @@ interface IgGridUpdating { editCellEnded?: EditCellEndedEvent; /** - * Event fired before adding a new row. + * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51198,7 +51198,7 @@ interface IgGridUpdating { rowAdding?: RowAddingEvent; /** - * Event fired after adding a new row. + * Event fired after adding a new row. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51208,7 +51208,7 @@ interface IgGridUpdating { rowAdded?: RowAddedEvent; /** - * Event fired before deleting a row. + * Event fired before deleting a row. * Return false in order to cancel the row's deletion. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51219,7 +51219,7 @@ interface IgGridUpdating { rowDeleting?: RowDeletingEvent; /** - * Event fired after a row is deleted. + * Event fired after a row is deleted. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51229,7 +51229,7 @@ interface IgGridUpdating { rowDeleted?: RowDeletedEvent; /** - * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. + * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -51238,7 +51238,7 @@ interface IgGridUpdating { dataDirty?: DataDirtyEvent; /** - * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. + * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51247,7 +51247,7 @@ interface IgGridUpdating { generatePrimaryKeyValue?: GeneratePrimaryKeyValueEvent; /** - * Event fired before the row edit dialog is opened. + * Event fired before the row edit dialog is opened. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51256,7 +51256,7 @@ interface IgGridUpdating { rowEditDialogBeforeOpen?: RowEditDialogBeforeOpenEvent; /** - * Event fired after the row edit dialog is opened. + * Event fired after the row edit dialog is opened. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51265,7 +51265,7 @@ interface IgGridUpdating { rowEditDialogAfterOpen?: RowEditDialogAfterOpenEvent; /** - * Event fired before the row edit dialog is closed. + * Event fired before the row edit dialog is closed. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51274,7 +51274,7 @@ interface IgGridUpdating { rowEditDialogBeforeClose?: RowEditDialogBeforeCloseEvent; /** - * Event fired after the row edit dialog is closed. + * Event fired after the row edit dialog is closed. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51283,7 +51283,7 @@ interface IgGridUpdating { rowEditDialogAfterClose?: RowEditDialogAfterCloseEvent; /** - * Event fired after the row edit dialog is rendered. + * Event fired after the row edit dialog is rendered. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -51292,14 +51292,14 @@ interface IgGridUpdating { rowEditDialogContentsRendered?: RowEditDialogContentsRenderedEvent; /** - * Option for igGridUpdating + * Option for igGridUpdating */ [optionName: string]: any; } interface IgGridUpdatingMethods { /** - * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. - * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. + * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. + * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. * * @param rowId The primary key of the row the cell is a child of. * @param colKey The column key of the cell. @@ -51308,8 +51308,8 @@ interface IgGridUpdatingMethods { setCellValue(rowId: Object, colKey: string, value: Object): void; /** - * Sets values for specified cells in a row. It also creates a transaction and updates the UI. - * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. + * Sets values for specified cells in a row. It also creates a transaction and updates the UI. + * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. * * @param rowId The primary key of the row to update. * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . @@ -51317,21 +51317,21 @@ interface IgGridUpdatingMethods { updateRow(rowId: Object, values: Object): void; /** - * Adds a new row to the grid. It also creates a transaction and updates the UI. + * Adds a new row to the grid. It also creates a transaction and updates the UI. * * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ addRow(values: Object): void; /** - * Deletes a row from the grid. It also creates a transaction and updates the UI. + * Deletes a row from the grid. It also creates a transaction and updates the UI. * * @param rowId The primary key of the row to delete. */ deleteRow(rowId: Object): void; /** - * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). + * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). * * @param rowId The row id. * @param column The column key or index. @@ -51340,14 +51340,14 @@ interface IgGridUpdatingMethods { startEdit(rowId: Object, column: Object, raiseEvents?: boolean): boolean; /** - * Starts editing for adding a new row. + * Starts editing for adding a new row. * * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddRowEdit(raiseEvents?: boolean): boolean; /** - * Ends the currently active edit mode. + * Ends the currently active edit mode. * * @param update Specifies if the edit process should accept the current changes. Default is 'false'. * @param raiseEvents Specifies whether or not updating events should be raised for this operation. @@ -51355,24 +51355,24 @@ interface IgGridUpdatingMethods { endEdit(update?: boolean, raiseEvents?: boolean): boolean; /** - * Finds and returns the key of the first column the editor for which has invalid value. + * Finds and returns the key of the first column the editor for which has invalid value. */ findInvalid(): string; /** - * Checks if the grid is in edit mode. + * Checks if the grid is in edit mode. */ isEditing(): boolean; /** - * Gets the editor for a column by the column key. That method can be used only after the editor has been created. + * Gets the editor for a column by the column key. That method can be used only after the editor has been created. * * @param key The key of the column. */ editorForKey(key: string): Object; /** - * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. + * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. * * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. * @param create Requests to create the editor if it has not been created yet. @@ -51380,19 +51380,19 @@ interface IgGridUpdatingMethods { editorForCell(cell: string, create?: boolean): Object; /** - * Destroys igGridUpdating. + * Destroys igGridUpdating. */ destroy(): Object; /** - * Shows the delete button for specific row. + * Shows the delete button for specific row. * * @param row A jQuery object of the targeted row. */ showDeleteButtonFor(row: Object): void; /** - * Hides the delete button. + * Hides the delete button. */ hideDeleteButton(): void; } @@ -52323,160 +52323,160 @@ interface WorkspaceResizedEventUIParam { interface IgHtmlEditor { /** - * Shows/hides the "Formatting" toolbar. + * Shows/hides the "Formatting" toolbar. * */ showFormattingToolbar?: boolean; /** - * Shows/hides the "Text" toolbar. + * Shows/hides the "Text" toolbar. * */ showTextToolbar?: boolean; /** - * Shows/hides the "Insert Object" toolbar. + * Shows/hides the "Insert Object" toolbar. * */ showInsertObjectToolbar?: boolean; /** - * Shows/hides the "Copy Paste" toolbar. + * Shows/hides the "Copy Paste" toolbar. * */ showCopyPasteToolbar?: boolean; /** - * The width of the html editor. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the html editor. It can be set as a number in pixels, string (px) or percentage (%). * */ width?: string|number; /** - * The height of the html editor. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the html editor. It can be set as a number in pixels, string (px) or percentage (%). * */ height?: string|number; /** - * The html editor toolbars list. + * The html editor toolbars list. * */ toolbarSettings?: any[]; /** - * The html editor custom toolbars list. + * The html editor custom toolbars list. * */ customToolbars?: any[]; /** - * The name attribute of the html editor source view. + * The name attribute of the html editor source view. * */ inputName?: string; /** - * Used to render inside the html editor as initial content + * Used to render inside the html editor as initial content * */ value?: string; /** - * Event fired after the html editor widget has been rendered. + * Event fired after the html editor widget has been rendered. */ rendered?: RenderedEvent; /** - * Event fired before the html editor widget is rendered. + * Event fired before the html editor widget is rendered. */ rendering?: RenderingEvent; /** - * Event fired before a toolbar item is clicked. + * Event fired before a toolbar item is clicked. */ actionExecuting?: ActionExecutingEvent; /** - * Event fired after a toolbar item is clicked. + * Event fired after a toolbar item is clicked. */ actionExecuted?: ActionExecutedEvent; /** - * Event fired before a toolbar is collapsed. + * Event fired before a toolbar is collapsed. */ toolbarCollapsing?: ToolbarCollapsingEvent; /** - * Event fired after a toolbar is collapsed. + * Event fired after a toolbar is collapsed. */ toolbarCollapsed?: ToolbarCollapsedEvent; /** - * Event fired before a toolbar is expanded. + * Event fired before a toolbar is expanded. */ toolbarExpanding?: ToolbarExpandingEvent; /** - * Event fired after a toolbar is expanded. + * Event fired after a toolbar is expanded. */ toolbarExpanded?: ToolbarExpandedEvent; /** - * Event is fired on keyboard cut action. + * Event is fired on keyboard cut action. */ cut?: CutEvent; /** - * Event is fired on keyboard copy action. + * Event is fired on keyboard copy action. */ copy?: CopyEvent; /** - * Event is fired on keyboard paste action. + * Event is fired on keyboard paste action. */ paste?: PasteEvent; /** - * Event is fired on keyboard undo action. + * Event is fired on keyboard undo action. */ undo?: UndoEvent; /** - * Event is fired on keyboard redo action. + * Event is fired on keyboard redo action. */ redo?: RedoEvent; /** - * Event is fired after the workspace has been resized + * Event is fired after the workspace has been resized */ workspaceResized?: WorkspaceResizedEvent; /** - * Option for igHtmlEditor + * Option for igHtmlEditor */ [optionName: string]: any; } interface IgHtmlEditorMethods { /** - * Returns the element on which the widget was instantiated + * Returns the element on which the widget was instantiated */ widget(): void; /** - * Resizes the height of the workspace + * Resizes the height of the workspace */ resizeWorkspace(): void; /** - * Gets the content of the html editor. + * Gets the content of the html editor. * * @param format Returns the content as html or plain text. Values can be "text" or "html". */ getContent(format: string): string; /** - * Sets the content of the html editor. + * Sets the content of the html editor. * * @param content The content which will be set. * @param format The content type: "text" or "html". @@ -52484,12 +52484,12 @@ interface IgHtmlEditorMethods { setContent(content: string, format: string): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Executes htmleditor commands. + * Executes htmleditor commands. * * @param actionName The command name. * @param args Additional parameter for the command. @@ -52497,37 +52497,37 @@ interface IgHtmlEditorMethods { executeAction(actionName: string, args?: Object): void; /** - * Returns true/false if the editor contents were modified or not. + * Returns true/false if the editor contents were modified or not. */ isDirty(): Object; /** - * Returns the window object associated with the Html Editor's content editable area + * Returns the window object associated with the Html Editor's content editable area */ contentWindow(): Object; /** - * Returns the document object associated with the Html Editor's content editable area + * Returns the document object associated with the Html Editor's content editable area */ contentDocument(): Object; /** - * Returns the content editable associated with this Html Editor + * Returns the content editable associated with this Html Editor */ contentEditable(): Object; /** - * Returns Selection object that represent the current selection in the content editable + * Returns Selection object that represent the current selection in the content editable */ selection(): Object; /** - * Returns Range object that represent the current range in the content editable + * Returns Range object that represent the current range in the content editable */ range(): Object; /** - * Inserts the provided content at the position of the caret. + * Inserts the provided content at the position of the caret. * * @param element Accepts html string, DOM element or a jQuery object. */ @@ -52541,7 +52541,7 @@ interface IgPathFinder { items?: any; /** - * Option for igPathFinder + * Option for igPathFinder */ [optionName: string]: any; } @@ -52584,7 +52584,7 @@ interface IgHtmlEditorPopover { hide?: HideEvent; /** - * Option for igHtmlEditorPopover + * Option for igHtmlEditorPopover */ [optionName: string]: any; } @@ -52606,7 +52606,7 @@ interface IgLinkPropertiesDialog { hide?: HideEvent; /** - * Option for igLinkPropertiesDialog + * Option for igLinkPropertiesDialog */ [optionName: string]: any; } @@ -52628,7 +52628,7 @@ interface IgTablePropertiesDialog { hide?: HideEvent; /** - * Option for igTablePropertiesDialog + * Option for igTablePropertiesDialog */ [optionName: string]: any; } @@ -52650,7 +52650,7 @@ interface IgImagePropertiesDialog { hide?: HideEvent; /** - * Option for igImagePropertiesDialog + * Option for igImagePropertiesDialog */ [optionName: string]: any; } @@ -53289,150 +53289,150 @@ interface JQuery { } interface IgLayoutManagerBorderLayout { /** - * Option specifying the width of the left region, either in px or percentages + * Option specifying the width of the left region, either in px or percentages * */ leftWidth?: string; /** - * Option specifying the width of the right region, either in px or percentages + * Option specifying the width of the right region, either in px or percentages * */ rightWidth?: string; /** - * Option specifying whether the footer region in the border layout will be hidden or shown + * Option specifying whether the footer region in the border layout will be hidden or shown * */ showFooter?: boolean; /** - * Option specifying whether the header region in the border layout will be hidden or shown + * Option specifying whether the header region in the border layout will be hidden or shown * */ showHeader?: boolean; /** - * Option specifying whether the left region in the border layout will be hidden or shown + * Option specifying whether the left region in the border layout will be hidden or shown * */ showLeft?: boolean; /** - * Option specifying whether the right region in the border layout will be hidden or shown + * Option specifying whether the right region in the border layout will be hidden or shown * */ showRight?: boolean; /** - * Option for IgLayoutManagerBorderLayout + * Option for IgLayoutManagerBorderLayout */ [optionName: string]: any; } interface IgLayoutManagerGridLayout { /** - * Specifies the duration of the animations in the layout manager"s grid layout + * Specifies the duration of the animations in the layout manager"s grid layout * */ animationDuration?: number; /** - * Number of columns in the grid + * Number of columns in the grid * */ cols?: number; /** - * Accepts number or string with height in px or percents + * Accepts number or string with height in px or percents * */ columnHeight?: string|number; /** - * Accepts number or string with width in px or percents + * Accepts number or string with width in px or percents * */ columnWidth?: string|number; /** - * Specifies the margin left css property for items + * Specifies the margin left css property for items * */ marginLeft?: number; /** - * Specifies the margin top css property for items + * Specifies the margin top css property for items * */ marginTop?: number; /** - * Specifies whether the previous set options should be overriden when setting options + * Specifies whether the previous set options should be overriden when setting options * */ overrideConfigOnSetOption?: boolean; /** - * Specified whether the items should rearrange to fit in the container when it is resized. + * Specified whether the items should rearrange to fit in the container when it is resized. * Have effect only when fixed columnWidth option is set. * */ rearrangeItems?: boolean; /** - * Number of rows in the grid + * Number of rows in the grid * */ rows?: number; /** - * Option for IgLayoutManagerGridLayout + * Option for IgLayoutManagerGridLayout */ [optionName: string]: any; } interface IgLayoutManagerItem { /** - * Column index of the item in the grid + * Column index of the item in the grid * */ colIndex?: number; /** - * ColSpan of the item + * ColSpan of the item * */ colSpan?: number; /** - * Gets/Sets individual item height, either in px or percentage + * Gets/Sets individual item height, either in px or percentage * string The default height can be set in pixels (px), %, em and other units. * */ height?: string; /** - * Row index of the item in the grid + * Row index of the item in the grid * */ rowIndex?: number; /** - * RowSpan of the item + * RowSpan of the item * */ rowSpan?: number; /** - * Gets/Sets individual item width, either in px or percentage + * Gets/Sets individual item width, either in px or percentage * string The default width can be set in pixels (px), %, em and other units. * */ width?: number; /** - * Option for IgLayoutManagerItem + * Option for IgLayoutManagerItem */ [optionName: string]: any; } @@ -53443,7 +53443,7 @@ interface InternalResizedEvent { interface InternalResizedEventUIParam { /** - * Used to get a reference to the layout manager performing resizing. + * Used to get a reference to the layout manager performing resizing. */ owner?: any; } @@ -53454,7 +53454,7 @@ interface InternalResizingEvent { interface InternalResizingEventUIParam { /** - * Used to get a reference to the layout manager performing resizing. + * Used to get a reference to the layout manager performing resizing. */ owner?: any; } @@ -53465,22 +53465,22 @@ interface ItemRenderedEvent { interface ItemRenderedEventUIParam { /** - * Used to get reference to the igLayoutManager. + * Used to get reference to the igLayoutManager. */ owner?: any; /** - * Used to get a reference of item's settings, such as colspan ,rowspan, etc. + * Used to get a reference of item's settings, such as colspan ,rowspan, etc. */ itemData?: any; /** - * Used to get a reference of the item's index, if the layout is flow or vertical + * Used to get a reference of the item's index, if the layout is flow or vertical */ index?: any; /** - * Used to get a reference to the rendered item + * Used to get a reference to the rendered item */ item?: any; } @@ -53491,53 +53491,53 @@ interface ItemRenderingEvent { interface ItemRenderingEventUIParam { /** - * Used to get reference to the igLayoutManager. + * Used to get reference to the igLayoutManager. */ owner?: any; /** - * Used to get a reference of item's settings, such as colspan ,rowspan, etc. + * Used to get a reference of item's settings, such as colspan ,rowspan, etc. */ itemData?: any; /** - * Used to get a reference of the item's index, if the layout is flow or vertical + * Used to get a reference of the item's index, if the layout is flow or vertical */ index?: any; /** - * Used to get a reference to the rendered item + * Used to get a reference to the rendered item */ item?: any; } interface IgLayoutManager { /** - * Options specific to a border layout + * Options specific to a border layout * */ borderLayout?: IgLayoutManagerBorderLayout; /** - * Options specific to grid layout mode + * Options specific to grid layout mode * */ gridLayout?: IgLayoutManagerGridLayout; /** - * Gets/Sets height of the layout container. + * Gets/Sets height of the layout container. * */ height?: string|number; /** - * Number of items to render, this is only applicable to layouts: vertical and flow + * Number of items to render, this is only applicable to layouts: vertical and flow * */ itemCount?: number; /** - * An array of item descriptions + * An array of item descriptions * this assumes the container is empty, and every item * is described by rowspan, colspan, etc. - otherwise values of * 1 are assumed @@ -53549,7 +53549,7 @@ interface IgLayoutManager { items?: IgLayoutManagerItem[]; /** - * Defines the layout type + * Defines the layout type * grid Column type can be set with grid layout * border Column type can be set with border layout * flow Column type can be set with flow layout @@ -53567,25 +53567,25 @@ interface IgLayoutManager { layoutMode?: any; /** - * Gets/Sets width of the layout container. + * Gets/Sets width of the layout container. * */ width?: string|number; /** - * Event fired after items are resized. + * Event fired after items are resized. * Use ui.owner to get a reference to the layout manager performing resizing. */ internalResized?: InternalResizedEvent; /** - * Event fired before items are resized. + * Event fired before items are resized. * Use ui.owner to get a reference to the layout manager performing resizing. */ internalResizing?: InternalResizingEvent; /** - * Event fired after an item has been rendered in the container. + * Event fired after an item has been rendered in the container. * Function takes arguments evt and ui. * Use ui.owner to get reference to the igLayoutManager. * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. @@ -53595,7 +53595,7 @@ interface IgLayoutManager { itemRendered?: ItemRenderedEvent; /** - * Event fired before an item is rendered in the container. + * Event fired before an item is rendered in the container. * Function takes arguments evt and ui. * Use ui.owner to get reference to the igLayoutManager. * Use ui.itemData to get a reference of item's settings, such as colspan ,rowspan, etc. @@ -53605,20 +53605,20 @@ interface IgLayoutManager { itemRendering?: ItemRenderingEvent; /** - * Event fired after all items are rendered. + * Event fired after all items are rendered. * Function takes arguments evt and ui. * Use ui.owner to get reference to the igLayoutManager. */ rendered?: RenderedEvent; /** - * Option for igLayoutManager + * Option for igLayoutManager */ [optionName: string]: any; } interface IgLayoutManagerMethods { /** - * Triggers recalculation of the layout dimensions. Layouts may not need to be reflowed manually, if their sizes are in percentages (i.e. they are responsive by default) + * Triggers recalculation of the layout dimensions. Layouts may not need to be reflowed manually, if their sizes are in percentages (i.e. they are responsive by default) * this can be particularly useful with a grid layout, when the container has percentage sizes, but items are calculated in pixels and positioned absolutely in the container. * * @param forceReflow Indicates whether the reflow should be forced. Useful in cases where the items size and position was changed manually. @@ -53628,7 +53628,7 @@ interface IgLayoutManagerMethods { reflow(forceReflow?: boolean, animationDuration?: number, event?: Object): void; /** - * Destroy is part of the jQuery UI widget API and does the following: + * Destroy is part of the jQuery UI widget API and does the following: * 1. Remove custom CSS classes that were added. * 2. Remove any elements that were added at widget's initialization and after that, which didn't below to the original markup * 3. Unbind all events that were bound. @@ -53858,93 +53858,93 @@ interface JQuery { } interface IgLinearGaugeRange { /** - * Gets or sets the name of the range. + * Gets or sets the name of the range. */ name?: string; /** - * Gets or sets the brush to use to fill the range. + * Gets or sets the brush to use to fill the range. */ brush?: string; /** - * Gets or sets the outline to use when rendering the range. + * Gets or sets the outline to use when rendering the range. */ outline?: string; /** - * Gets or sets the value at which the range starts along the scale. + * Gets or sets the value at which the range starts along the scale. */ startValue?: number; /** - * Gets or sets the value at which the range ends along the scale. + * Gets or sets the value at which the range ends along the scale. */ endValue?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ innerStartExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ innerEndExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ outerStartExtent?: number; /** - * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. + * Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. * Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. */ outerEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering this range's outline. + * Gets or sets the stroke thickness to use when rendering this range's outline. */ strokeThickness?: number; /** - * Option for IgLinearGaugeRange + * Option for IgLinearGaugeRange */ [optionName: string]: any; } interface IgLinearGauge { /** - * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Gets or sets the scale ranges to render on the linear gauge. + * Gets or sets the scale ranges to render on the linear gauge. */ ranges?: IgLinearGaugeRange[]; /** - * Gets or sets the ranges' tooltip template. + * Gets or sets the ranges' tooltip template. */ rangeToolTipTemplate?: string; /** - * Gets or sets the needle's tooltip template. + * Gets or sets the needle's tooltip template. */ needleToolTipTemplate?: string; /** - * Gets or sets the orientation of the scale. + * Gets or sets the orientation of the scale. * * Valid values: * "horizontal" @@ -53953,34 +53953,34 @@ interface IgLinearGauge { orientation?: string; /** - * Gets or sets a collection of brushes to be used as the palette for linear gauge ranges. + * Gets or sets a collection of brushes to be used as the palette for linear gauge ranges. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeBrushes?: any; /** - * Gets or sets a collection of brushes to be used as the palette for linear gauge outlines. + * Gets or sets a collection of brushes to be used as the palette for linear gauge outlines. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeOutlines?: any; /** - * Gets or sets the minimum value of the scale. + * Gets or sets the minimum value of the scale. */ minimumValue?: number; /** - * Gets or sets the maximum value of the scale. + * Gets or sets the maximum value of the scale. */ maximumValue?: number; /** - * Gets or sets the value at which the needle is positioned. + * Gets or sets the value at which the needle is positioned. */ value?: number; /** - * Gets or sets the shape to use when rendering the needle from a number of options. + * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: * "custom" @@ -53992,315 +53992,315 @@ interface IgLinearGauge { needleShape?: string; /** - * Gets or sets the name used for needle. + * Gets or sets the name used for needle. */ needleName?: string; /** - * Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. + * Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ rangeInnerExtent?: number; /** - * Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. + * Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ scaleInnerExtent?: number; /** - * Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ rangeOuterExtent?: number; /** - * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. + * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ scaleOuterExtent?: number; /** - * Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear gauge as a value from 0 to 1. + * Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear gauge as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ needleInnerExtent?: number; /** - * Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ needleOuterExtent?: number; /** - * Gets or sets the width of the needle's inner base. + * Gets or sets the width of the needle's inner base. */ needleInnerBaseWidth?: number; /** - * Gets or sets the width of the needle's outer base. + * Gets or sets the width of the needle's outer base. */ needleOuterBaseWidth?: number; /** - * Gets or sets the width of the needle's inner point. + * Gets or sets the width of the needle's inner point. */ needleInnerPointWidth?: number; /** - * Gets or sets the width of the needle's outer point. + * Gets or sets the width of the needle's outer point. */ needleOuterPointWidth?: number; /** - * Gets or sets the extent of the needle's inner point. + * Gets or sets the extent of the needle's inner point. */ needleInnerPointExtent?: number; /** - * Gets or sets the extent of the needle's outer point. + * Gets or sets the extent of the needle's outer point. */ needleOuterPointExtent?: number; /** - * Gets or sets the interval to use for the scale. + * Gets or sets the interval to use for the scale. */ interval?: number; /** - * A value to start adding tickmarks, added to the scale's MinimumValue. + * A value to start adding tickmarks, added to the scale's MinimumValue. */ ticksPostInitial?: number; /** - * A value to stop adding tickmarks, subtracted from the scale's MaximumValue. + * A value to stop adding tickmarks, subtracted from the scale's MaximumValue. */ ticksPreTerminal?: number; /** - * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. + * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. */ labelInterval?: number; /** - * Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. + * Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. * Values further from zero than 1 can be used to hide the labels of the linear gauge. */ labelExtent?: number; /** - * A value to start adding labels, added to the scale's MinimumValue. + * A value to start adding labels, added to the scale's MinimumValue. */ labelsPostInitial?: number; /** - * A value to stop adding labels, subtracted from the scale's MaximumValue. + * A value to stop adding labels, subtracted from the scale's MaximumValue. */ labelsPreTerminal?: number; /** - * Gets or sets the number of minor tickmarks to place between major tickmarks. + * Gets or sets the number of minor tickmarks to place between major tickmarks. */ minorTickCount?: number; /** - * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ tickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ tickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering ticks. + * Gets or sets the stroke thickness to use when rendering ticks. */ tickStrokeThickness?: number; /** - * Gets or sets the brush to use for the major tickmarks. + * Gets or sets the brush to use for the major tickmarks. */ tickBrush?: string; /** - * Gets or sets the brush to use for the label font. + * Gets or sets the brush to use for the label font. */ fontBrush?: string; /** - * Gets or sets the needle breadth. + * Gets or sets the needle breadth. */ needleBreadth?: number; /** - * Gets or sets the brush to use for needle element. + * Gets or sets the brush to use for needle element. */ needleBrush?: string; /** - * Gets or sets the brush to use for the outline of needle element. + * Gets or sets the brush to use for the outline of needle element. */ needleOutline?: string; /** - * Gets or sets the stroke thickness to use when rendering single actual value element. + * Gets or sets the stroke thickness to use when rendering single actual value element. */ needleStrokeThickness?: number; /** - * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ minorTickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ minorTickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering minor ticks. + * Gets or sets the stroke thickness to use when rendering minor ticks. */ minorTickStrokeThickness?: number; /** - * Gets or sets the brush to use for the minor tickmarks. + * Gets or sets the brush to use for the minor tickmarks. */ minorTickBrush?: string; /** - * Gets or sets a value indicating whether the scale is inverted. + * Gets or sets a value indicating whether the scale is inverted. * When the scale is inverted the direction in which the scale values increase is right to left. */ isScaleInverted?: boolean; /** - * Gets or sets the brush to use to fill the backing of the linear gauge. + * Gets or sets the brush to use to fill the backing of the linear gauge. */ backingBrush?: string; /** - * Gets or sets the brush to use for the outline of the backing. + * Gets or sets the brush to use for the outline of the backing. */ backingOutline?: string; /** - * Gets or sets the stroke thickness of the backing outline. + * Gets or sets the stroke thickness of the backing outline. */ backingStrokeThickness?: number; /** - * Gets or sets the inner extent of the linear gauge backing. + * Gets or sets the inner extent of the linear gauge backing. */ backingInnerExtent?: number; /** - * Gets or sets the outer extent of the linear gauge backing. + * Gets or sets the outer extent of the linear gauge backing. */ backingOuterExtent?: number; /** - * Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear gauge as a value from 0 to 1. + * Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear gauge as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ scaleStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the linear gauge. + * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the linear gauge. * Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. */ scaleEndExtent?: number; /** - * Gets or sets the brush to use to fill the scale of the linear gauge. + * Gets or sets the brush to use to fill the scale of the linear gauge. */ scaleBrush?: string; /** - * Gets or sets the brush to use for the outline of the scale. + * Gets or sets the brush to use for the outline of the scale. */ scaleOutline?: string; /** - * Gets or sets the stroke thickness of the scale outline. + * Gets or sets the stroke thickness of the scale outline. */ scaleStrokeThickness?: number; /** - * Gets or sets whether needle dragging is enabled or not. + * Gets or sets whether needle dragging is enabled or not. */ isNeedleDraggingEnabled?: boolean; /** - * Gets or sets the number of milliseconds over which changes to the linear gauge should be animated. + * Gets or sets the number of milliseconds over which changes to the linear gauge should be animated. */ transitionDuration?: number; /** - * Gets or sets the time in milliseconds that tooltip appearance is delayed with. + * Gets or sets the time in milliseconds that tooltip appearance is delayed with. */ showToolTipTimeout?: number; /** - * Gets or sets a value indicating whether tooltips are enabled. + * Gets or sets a value indicating whether tooltips are enabled. */ showToolTip?: boolean; /** - * Gets or sets the font. + * Gets or sets the font. */ font?: string; /** - * Gets or sets the pixel scaling ratio for the gauge. + * Gets or sets the pixel scaling ratio for the gauge. */ pixelScalingRatio?: number; formatLabel?: FormatLabelEvent; alignLabel?: AlignLabelEvent; /** - * Occurs when the Value property changes. + * Occurs when the Value property changes. */ valueChanged?: ValueChangedEvent; /** - * Option for igLinearGauge + * Option for igLinearGauge */ [optionName: string]: any; } interface IgLinearGaugeMethods { /** - * Returns a string containing the names of all the ranges delimited with a \n symbol. + * Returns a string containing the names of all the ranges delimited with a \n symbol. */ getRangeNames(): string; /** - * Adds a new range to the linear gauge. + * Adds a new range to the linear gauge. * * @param value The range object to be added. */ addRange(value: Object): void; /** - * Removes a range from the linear gauge. + * Removes a range from the linear gauge. * * @param value A JS object with properties set as follows: name: nameOfTheRangeToRemove, remove: true */ removeRange(value: Object): void; /** - * Updates the specified range of the linear gauge. + * Updates the specified range of the linear gauge. * * @param value The range object to be updated. */ updateRange(value: Object): void; /** - * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. + * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * * @param x * @param y @@ -54308,7 +54308,7 @@ interface IgLinearGaugeMethods { getValueForPoint(x: Object, y: Object): number; /** - * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. + * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. * * @param x The x coordinate of the point. * @param y The y coordinate of the point. @@ -54316,22 +54316,22 @@ interface IgLinearGaugeMethods { needleContainsPoint(x: number, y: number): void; /** - * Returns information about how the linear gauge is rendered. + * Returns information about how the linear gauge is rendered. */ exportVisualData(): Object; /** - * Causes all pending changes of the linear gauge e.g. by changed property values to be rendered immediately. + * Causes all pending changes of the linear gauge e.g. by changed property values to be rendered immediately. */ flush(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; /** - * Re-polls the css styles for the widget. Use this method when the css styles have been modified. + * Re-polls the css styles for the widget. Use this method when the css styles have been modified. */ styleUpdated(): void; } @@ -55174,24 +55174,24 @@ interface JQuery { } interface IgMapCrosshairPoint { /** - * The x coordinate. + * The x coordinate. */ x?: number; /** - * The y coordinate. + * The y coordinate. */ y?: number; /** - * Option for IgMapCrosshairPoint + * Option for IgMapCrosshairPoint */ [optionName: string]: any; } interface IgMapBackgroundContent { /** - * Type of the background content for the map. + * Type of the background content for the map. * * Valid values: * "openStreet" Specify the background content to display OpenStreetMap geographic data. Set as default. @@ -55201,39 +55201,39 @@ interface IgMapBackgroundContent { type?: string; /** - * Gets or sets the key. + * Gets or sets the key. */ key?: string; /** - * Gets or sets the parameter. + * Gets or sets the parameter. */ parameter?: string; /** - * Gets or sets the map tile image uri. This is a bing maps specific option + * Gets or sets the map tile image uri. This is a bing maps specific option */ tilePath?: string; /** - * Gets or sets the type of the imagery. + * Gets or sets the type of the imagery. */ imagerySet?: string; /** - * Gets or sets the bing maps url + * Gets or sets the bing maps url */ bingUrl?: string; /** - * Option for IgMapBackgroundContent + * Option for IgMapBackgroundContent */ [optionName: string]: any; } interface IgMapSeries { /** - * Type of the series. + * Type of the series. * * Valid values: * "geographicSymbolSeries" Specify the series as geographic Symbol Series series. @@ -55247,57 +55247,57 @@ interface IgMapSeries { type?: string; /** - * The unique identifier of the series. + * The unique identifier of the series. */ name?: string; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Set to true in order to have an existing series removed from the map, by name + * Set to true in order to have an existing series removed from the map, by name */ remove?: boolean; /** - * Whether the map should render a tooltip. + * Whether the map should render a tooltip. */ showTooltip?: boolean; /** - * The triangulated file source URI or an instance of $.ig.ShapeDataSource. + * The triangulated file source URI or an instance of $.ig.ShapeDataSource. */ shapeDataSource?: string; /** - * String The database source URI. + * String The database source URI. */ databaseSource?: string; /** - * The triangulated file source URI or an instance of $.ig.TriangulationDataSource. + * The triangulated file source URI or an instance of $.ig.TriangulationDataSource. */ triangulationDataSource?: string; /** - * Gets or sets the LegendItemBadgeTemplate property. + * Gets or sets the LegendItemBadgeTemplate property. * The legend item badge is created according to the LegendItemBadgeTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. @@ -55324,7 +55324,7 @@ interface IgMapSeries { legendItemBadgeTemplate?: any; /** - * Gets or sets the LegendItemTemplate property. + * Gets or sets the LegendItemTemplate property. * The legend item control content is created according to the LegendItemTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55332,7 +55332,7 @@ interface IgMapSeries { legendItemTemplate?: any; /** - * Gets or sets the DiscreteLegendItemTemplate property. + * Gets or sets the DiscreteLegendItemTemplate property. * The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by * the series object itself. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55340,87 +55340,87 @@ interface IgMapSeries { discreteLegendItemTemplate?: any; /** - * Gets or sets the duration of the current series's morph. + * Gets or sets the duration of the current series's morph. */ transitionDuration?: number; /** - * Gets or sets the current series object's rendering resolution. + * Gets or sets the current series object's rendering resolution. */ resolution?: number; /** - * Gets or sets the Title property. + * Gets or sets the Title property. * The legend item control is created according to the Title on-demand by * the series object itself. */ title?: string; /** - * Gets or sets the brush to use for the series. + * Gets or sets the brush to use for the series. */ brush?: string; /** - * Gets or sets the brush to use for the outline of the series. + * Gets or sets the brush to use for the outline of the series. * Some series types, such as LineSeries, do not display outlines. */ outline?: string; /** - * Gets or sets the width of the current series object's line thickness. + * Gets or sets the width of the current series object's line thickness. */ thickness?: number; /** - * The source of triangulation data. + * The source of triangulation data. * This property is optional. If it is left as null, the triangulation will be created based on the items in the data source. Triangulation is a demanding operation, so the runtime performance will be better when specifying a TriangulationSource, especially when a large number of data items are present. */ trianglesSource?: any; /** - * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the first vertex point in the data source. + * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the first vertex point in the data source. */ triangleVertexMemberPath1?: string; /** - * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the second vertex point in the data source. + * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the second vertex point in the data source. */ triangleVertexMemberPath2?: string; /** - * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the third vertex point in the data source. + * The name of the property of the TrianglesSource items which, for each triangle, contains the index of the third vertex point in the data source. */ triangleVertexMemberPath3?: string; /** - * The ColorScale used to resolve the color values of points in the series. + * The ColorScale used to resolve the color values of points in the series. */ colorScale?: any; /** - * The name of the property on each data item containing a numeric value which can be converted to a color by the ColorScale. + * The name of the property on each data item containing a numeric value which can be converted to a color by the ColorScale. */ colorMemberPath?: string; /** - * The minimum scale at which this series becomes visible. + * The minimum scale at which this series becomes visible. * The default value for this property is 1.0, which means the series will always be visible. At a VisibleFromScale setting of 0.0, the series will never be visible. At a VisibleFromScale setting of 0.5, the series will be visible as long as the map is zoomed in to at least 200%. */ visibleFromScale?: number; /** - * The name of the property of data source items which contains the longitude coordinate of the symbol. + * The name of the property of data source items which contains the longitude coordinate of the symbol. */ longitudeMemberPath?: string; /** - * The name of the property of data source items which contains the latitude coordinate of the symbol. + * The name of the property of data source items which contains the latitude coordinate of the symbol. */ latitudeMemberPath?: string; /** - * Gets or sets the marker type for the current series object.If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored. + * Gets or sets the marker type for the current series object.If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored. * * * Valid values: @@ -55441,7 +55441,7 @@ interface IgMapSeries { markerType?: string; /** - * Gets or sets the MarkerTemplate for the current series object. + * Gets or sets the MarkerTemplate for the current series object. * The provided object should have properties called render and optionally measure. * These are functions which will be called that will be called to handle the user specified custom rendering. * measure will be passed an object that looks like this: @@ -55466,33 +55466,33 @@ interface IgMapSeries { markerTemplate?: any; /** - * The name of the property on data source items which, for each shape, contains a list of points to be converted to a polygon. + * The name of the property on data source items which, for each shape, contains a list of points to be converted to a polygon. * To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points. */ shapeMemberPath?: string; /** - * The StyleSelector which is used to select a style for each Shape. + * The StyleSelector which is used to select a style for each Shape. */ shapeStyleSelector?: any; /** - * The default style to apply to all Shapes in the series. + * The default style to apply to all Shapes in the series. */ shapeStyle?: any; /** - * Gets or sets the brush that specifies how the current series object's marker interiors are painted. + * Gets or sets the brush that specifies how the current series object's marker interiors are painted. */ markerBrush?: string; /** - * Gets or sets the brush that specifies how the current series object's marker outlines are painted. + * Gets or sets the brush that specifies how the current series object's marker outlines are painted. */ markerOutline?: string; /** - * Gets or sets the MarkerCollisionAvoidance + * Gets or sets the MarkerCollisionAvoidance * * Valid values: * "none" No collision avoidance is attempted. @@ -55503,17 +55503,17 @@ interface IgMapSeries { markerCollisionAvoidance?: string; /** - * The ValueBrushScale to use when determining Brushes for each Shape, based on the values found in FillMemberPath. + * The ValueBrushScale to use when determining Brushes for each Shape, based on the values found in FillMemberPath. */ fillScale?: any; /** - * The name of the property on data source items which contains a numeric value to convert to a Brush using the FillScale. + * The name of the property on data source items which contains a numeric value to convert to a Brush using the FillScale. */ fillMemberPath?: string; /** - * Gets or sets the trend type for the current scatter series. + * Gets or sets the trend type for the current scatter series. * * Valid values: * "none" No trendline should display. @@ -55534,61 +55534,61 @@ interface IgMapSeries { trendLineType?: string; /** - * Gets or sets the brush to use to draw the trend line. + * Gets or sets the brush to use to draw the trend line. */ trendLineBrush?: string; /** - * Gets or sets the thickness of the current scatter series object's trend line. + * Gets or sets the thickness of the current scatter series object's trend line. */ trendLineThickness?: number; /** - * Gets or sets the moving average period for the current scatter series object. + * Gets or sets the moving average period for the current scatter series object. * The typical, and initial, value for trend line period is 7. */ trendLinePeriod?: number; /** - * Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data. + * Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data. */ trendLineZIndex?: number; /** - * Gets or sets the maximum number of markerItems displayed by the current series. + * Gets or sets the maximum number of markerItems displayed by the current series. * If more than the specified number of markerItems are visible, the series will automatically * choose a representative set. */ maximumMarkers?: number; /** - * Gets or sets the radius mapping property for the current series object. + * Gets or sets the radius mapping property for the current series object. */ radiusMemberPath?: string; /** - * Gets or sets the radius size scale for the bubbles. + * Gets or sets the radius size scale for the bubbles. */ radiusScale?: any; /** - * Gets or sets the Label mapping property for the current series object. + * Gets or sets the Label mapping property for the current series object. */ labelMemberPath?: string; /** - * Gets or sets whether to clip the series to the bounds. + * Gets or sets whether to clip the series to the bounds. * Setting this to true can affect performance. */ clipSeriesToBounds?: boolean; /** - * Gets or sets the item path that provides the values for the current series. + * Gets or sets the item path that provides the values for the current series. */ valueMemberPath?: string; /** - * Determines how unknown values will be plotted on the map. Null and Double.NaN are two examples of unknown values. + * Determines how unknown values will be plotted on the map. Null and Double.NaN are two examples of unknown values. * * Valid values: * "linearInterpolate" Plot the unknown value as the midpoint between surrounding known values using linear interpolation. @@ -55597,28 +55597,28 @@ interface IgMapSeries { unknownValuePlotting?: string; /** - * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. + * Gets or sets the x-radius of the ellipse that is used to round the corners of the column. */ angleMemberPath?: number; /** - * Gets or sets whether Cartesian Interpolation should be used rather than Archimedian + * Gets or sets whether Cartesian Interpolation should be used rather than Archimedian * spiral based interpolation. */ useCartesianInterpolation?: boolean; /** - * Gets or sets the Stiffness property. + * Gets or sets the Stiffness property. */ stiffness?: number; /** - * Gets or sets the brush to use for negative portions of the series. + * Gets or sets the brush to use for negative portions of the series. */ negativeBrush?: string; /** - * Gets or sets the type of spline to be rendered. + * Gets or sets the type of spline to be rendered. * * Valid values: * "natural" Calculates the spline using a natural spline calculation formula. @@ -55627,96 +55627,96 @@ interface IgMapSeries { splineType?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ lowMemberPath?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ highMemberPath?: string; /** - * Gets or sets the value mapping property for the current series object. + * Gets or sets the value mapping property for the current series object. */ openMemberPath?: string; /** - * Gets or sets the close mapping property for the current series object. + * Gets or sets the close mapping property for the current series object. */ closeMemberPath?: string; /** - * Gets or sets the volume mapping property for the current series object. + * Gets or sets the volume mapping property for the current series object. */ volumeMemberPath?: string; /** - * Gets or sets the number of values to hide at the beginning of the indicator. + * Gets or sets the number of values to hide at the beginning of the indicator. */ ignoreFirst?: number; /** - * Gets or sets the moving average period for the current AverageDirectionalIndexIndicator object. + * Gets or sets the moving average period for the current AverageDirectionalIndexIndicator object. * The typical, and initial, value for AverageDirectionalIndexIndicator periods is 14. */ period?: number; /** - * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. + * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. * The typical, and initial, value for short AVO periods is 10. */ shortPeriod?: number; /** - * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. + * Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. * The typical, and initial, value for long AVO periods is 30. */ longPeriod?: number; /** - * Gets or sets the ContourValueResolver used to determine the numeric values of contours. + * Gets or sets the ContourValueResolver used to determine the numeric values of contours. */ valueResolver?: any; /** - * Gets or sets the resolution at which to filter out shapes in the series. + * Gets or sets the resolution at which to filter out shapes in the series. * For example, if the shapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. */ shapeFilterResolution?: number; /** - * Gets or sets the whether to use use brute force mode. + * Gets or sets the whether to use use brute force mode. */ useBruteForce?: boolean; /** - * Gets or sets the whether to progressively load the data into the map. + * Gets or sets the whether to progressively load the data into the map. */ progressiveLoad?: boolean; /** - * Gets or sets the whether the map reacts to mouse move events. + * Gets or sets the whether the map reacts to mouse move events. */ mouseOverEnabled?: boolean; /** - * Gets or sets the whether to use squares when halting a render traversal rather than the shape of the coalesced area. + * Gets or sets the whether to use squares when halting a render traversal rather than the shape of the coalesced area. */ useSquareCutoffStyle?: boolean; /** - * Gets or sets the density value that maps to the minimum heat color. + * Gets or sets the density value that maps to the minimum heat color. */ heatMinimum?: number; /** - * Gets or sets the value that maps to the maximum heat color. + * Gets or sets the value that maps to the maximum heat color. */ heatMaximum?: number; /** - * Option for IgMapSeries + * Option for IgMapSeries */ [optionName: string]: any; } @@ -55727,64 +55727,64 @@ interface TriangulationStatusChangedEvent { interface TriangulationStatusChangedEventUIParam { /** - * Used to get reference to map object. + * Used to get reference to map object. */ map?: any; /** - * Used to get reference to current series object. + * Used to get reference to current series object. */ series?: any; /** - * Used to get current status. + * Used to get current status. */ currentStatus?: any; } interface IgMap { /** - * The width of the map. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the map. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the map. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the map. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself + * Can be any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. Specifies the name of the property in which data records are held if the response is wrapped. */ responseDataKey?: string; /** - * Sets or gets the automatic width to add when automatically adding margins to the map. + * Sets or gets the automatic width to add when automatically adding margins to the map. */ autoMarginWidth?: number; /** - * Sets or gets the automatic height to add when automatically adding margins to the map. + * Sets or gets the automatic height to add when automatically adding margins to the map. */ autoMarginHeight?: number; /** - * Gets or sets the current Map's crosshair visibility override. + * Gets or sets the current Map's crosshair visibility override. * * Valid values: * "visible" Crosshair should be visible. @@ -55793,19 +55793,19 @@ interface IgMap { crosshairVisibility?: string; /** - * Gets or sets the cross hair point (in world coordinates) + * Gets or sets the cross hair point (in world coordinates) * Either or both of the crosshair point's X and Y may be set to double.NaN, in which * case the relevant crosshair line is hidden. */ crosshairPoint?: IgMapCrosshairPoint; /** - * Gets or sets the brush used as the background for the current Map object's plot area. + * Gets or sets the brush used as the background for the current Map object's plot area. */ plotAreaBackground?: string; /** - * Gets or sets the DefaultInteraction property. The default interaction state defines the map's response to mouse events. + * Gets or sets the DefaultInteraction property. The default interaction state defines the map's response to mouse events. * * Valid values: * "none" User gesture will not change the state of the map. @@ -55815,7 +55815,7 @@ interface IgMap { defaultInteraction?: string; /** - * Gets or sets the current Map's DragModifier property. + * Gets or sets the current Map's DragModifier property. * * Valid values: * "none" No modifier key is set. @@ -55826,7 +55826,7 @@ interface IgMap { dragModifier?: string; /** - * Gets or sets the current Map's PanModifier property. + * Gets or sets the current Map's PanModifier property. * * Valid values: * "none" No modifier key is set. @@ -55837,7 +55837,7 @@ interface IgMap { panModifier?: string; /** - * Gets or sets the preview rectangle. + * Gets or sets the preview rectangle. * The preview rectangle may be set to Rect.Empty, in which case the visible preview * strokePath is hidden. * The provided object should have numeric properties called left, top, width and height. @@ -55845,24 +55845,24 @@ interface IgMap { previewRect?: any; /** - * A rectangle representing the portion of the map currently in view. + * A rectangle representing the portion of the map currently in view. * A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in. * The provided object should have numeric properties called left, top, width and height. */ windowRect?: any; /** - * Gets or sets the current Map's zoomability. + * Gets or sets the current Map's zoomability. */ zoomable?: boolean; /** - * Gets or sets the current Map's zoom scale. + * Gets or sets the current Map's zoom scale. */ windowScale?: number; /** - * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. + * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * * * Valid values: @@ -55872,26 +55872,26 @@ interface IgMap { windowResponse?: string; /** - * Sets or gets the minimum width that the window rect is allowed to reach before being clamped. + * Sets or gets the minimum width that the window rect is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. */ windowRectMinWidth?: number; /** - * A number between 0 and 1 determining the position of the horizontal scroll. + * A number between 0 and 1 determining the position of the horizontal scroll. * This property is effectively a shortcut to the X position of the WindowRect property. */ windowPositionHorizontal?: number; /** - * A number between 0 and 1 determining the position of the vertical scroll. + * A number between 0 and 1 determining the position of the vertical scroll. * This property is effectively a shortcut to the Y position of the WindowRect property. */ windowPositionVertical?: number; /** - * Gets or sets the template to use for circle markers on the map. + * Gets or sets the template to use for circle markers on the map. * Defines the marker template used for * series with a marker type of circle. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55899,7 +55899,7 @@ interface IgMap { circleMarkerTemplate?: any; /** - * Gets or sets the template to use for triangle markers on the map. + * Gets or sets the template to use for triangle markers on the map. * Defines the marker template used for * series with a marker type of triangle. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55907,7 +55907,7 @@ interface IgMap { triangleMarkerTemplate?: any; /** - * Gets or sets the template to use for pyramid markers on the map. + * Gets or sets the template to use for pyramid markers on the map. * Defines the marker template used for * series with a marker type of pyramid. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55915,7 +55915,7 @@ interface IgMap { pyramidMarkerTemplate?: any; /** - * Gets or sets the template to use for square markers on the map. + * Gets or sets the template to use for square markers on the map. * Defines the marker template used for * series with a marker type of square. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55923,7 +55923,7 @@ interface IgMap { squareMarkerTemplate?: any; /** - * Gets or sets the template to use for diamond markers on the map. + * Gets or sets the template to use for diamond markers on the map. * Defines the marker template used for * series with a marker type of diamond. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55931,7 +55931,7 @@ interface IgMap { diamondMarkerTemplate?: any; /** - * Gets or sets the template to use for pentagon markers on the map. + * Gets or sets the template to use for pentagon markers on the map. * Defines the marker template used for * series with a marker type of pentagon. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55939,7 +55939,7 @@ interface IgMap { pentagonMarkerTemplate?: any; /** - * Gets or sets the template to use for hexagon markers on the map. + * Gets or sets the template to use for hexagon markers on the map. * Defines the marker template used for * series with a marker type of hexagon. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55947,7 +55947,7 @@ interface IgMap { hexagonMarkerTemplate?: any; /** - * Gets or sets the template to use for tetragram markers on the map. + * Gets or sets the template to use for tetragram markers on the map. * Defines the marker template used for * series with a marker type of tetragram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55955,7 +55955,7 @@ interface IgMap { tetragramMarkerTemplate?: any; /** - * Gets or sets the template to use for pentragram markers on the map. + * Gets or sets the template to use for pentragram markers on the map. * Defines the marker template used for * series with a marker type of pentagram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55963,7 +55963,7 @@ interface IgMap { pentagramMarkerTemplate?: any; /** - * Gets or sets the template to use for hexagram markers on the map. + * Gets or sets the template to use for hexagram markers on the map. * Defines the marker template used for * series with a marker type of hexagram. * The provided object should have properties called render and optionally measure. See definition for option: legendItemBadgeTemplate @@ -55971,42 +55971,42 @@ interface IgMap { hexagramMarkerTemplate?: any; /** - * The background image uri use in the overview detail pane. + * The background image uri use in the overview detail pane. */ overviewPlusDetailPaneBackgroundImageUri?: string; /** - * Sets whether the series viewer should use cached tiles during zooms rather than the default live content. + * Sets whether the series viewer should use cached tiles during zooms rather than the default live content. */ useTiledZooming?: boolean; /** - * Sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. + * Sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. */ preferHigherResolutionTiles?: boolean; /** - * Sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. + * Sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. */ zoomTileCacheSize?: number; /** - * Background content object + * Background content object */ backgroundContent?: IgMapBackgroundContent; /** - * An array of series objects + * An array of series objects */ series?: IgMapSeries[]; /** - * The swatch used to style this widget + * The swatch used to style this widget */ theme?: string; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -56018,7 +56018,7 @@ interface IgMap { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -56030,7 +56030,7 @@ interface IgMap { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left a series and the tooltip is about to hide + * Event fired when the mouse has left a series and the tooltip is about to hide * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -56042,7 +56042,7 @@ interface IgMap { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -56054,12 +56054,12 @@ interface IgMap { tooltipHidden?: TooltipHiddenEvent; /** - * Event fired when the control is displayed on a non HTML5 compliant browser + * Event fired when the control is displayed on a non HTML5 compliant browser */ browserNotSupported?: BrowserNotSupportedEvent; /** - * Occurs when the cursors are moved over a series in this map. + * Occurs when the cursors are moved over a series in this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56072,7 +56072,7 @@ interface IgMap { seriesCursorMouseMove?: SeriesCursorMouseMoveEvent; /** - * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this map. + * Occurs when the left mouse button is pressed while the mouse pointer is over an element of this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56085,7 +56085,7 @@ interface IgMap { seriesMouseLeftButtonDown?: SeriesMouseLeftButtonDownEvent; /** - * Occurs when the left mouse button is released while the mouse pointer is over an element of this map. + * Occurs when the left mouse button is released while the mouse pointer is over an element of this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56098,7 +56098,7 @@ interface IgMap { seriesMouseLeftButtonUp?: SeriesMouseLeftButtonUpEvent; /** - * Occurs when the left mouse pointer moves while over an element of this map. + * Occurs when the left mouse pointer moves while over an element of this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56111,7 +56111,7 @@ interface IgMap { seriesMouseMove?: SeriesMouseMoveEvent; /** - * Occurs when the left mouse pointer enters an element of this map. + * Occurs when the left mouse pointer enters an element of this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56124,7 +56124,7 @@ interface IgMap { seriesMouseEnter?: SeriesMouseEnterEvent; /** - * Occurs when the left mouse pointer leaves an element of this map. + * Occurs when the left mouse pointer leaves an element of this map. * Function takes arguments evt and ui. * Use ui.item to get reference to current series item object. * Use ui.map to get reference to map object. @@ -56137,7 +56137,7 @@ interface IgMap { seriesMouseLeave?: SeriesMouseLeaveEvent; /** - * Occurs just after the current Map's window rectangle is changed. + * Occurs just after the current Map's window rectangle is changed. * Function takes arguments evt and ui. * Use ui.map to get reference to map object. * Use ui.newHeight to get new height value. @@ -56152,7 +56152,7 @@ interface IgMap { windowRectChanged?: WindowRectChangedEvent; /** - * Occurs just after the current Map's grid area rectangle is changed. + * Occurs just after the current Map's grid area rectangle is changed. * The grid area may change as the result of the Map being resized. * Function takes arguments evt and ui. * Use ui.map to get reference to map object. @@ -56168,14 +56168,14 @@ interface IgMap { gridAreaRectChanged?: GridAreaRectChangedEvent; /** - * Raised when the map's processing for an update has completed. + * Raised when the map's processing for an update has completed. * Function takes arguments evt and ui. * Use ui.map to get reference to map object. */ refreshCompleted?: RefreshCompletedEvent; /** - * Event fired when the status of an ongoing Triangulation has changed. + * Event fired when the status of an ongoing Triangulation has changed. * Function takes arguments evt and ui. * Use ui.map to get reference to map object. * Use ui.series to get reference to current series object. @@ -56184,7 +56184,7 @@ interface IgMap { triangulationStatusChanged?: TriangulationStatusChangedEvent; /** - * Option for igMap + * Option for igMap */ [optionName: string]: any; } @@ -56192,17 +56192,17 @@ interface IgMapMethods { option(): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Returns the ID of parent element holding the map. + * Returns the ID of parent element holding the map. */ id(): string; /** - * Exports the map to a PNG image. + * Exports the map to a PNG image. * * @param width The width of the image. * @param height The height of the image. @@ -56210,17 +56210,17 @@ interface IgMapMethods { exportImage(width?: Object, height?: Object): Object; /** - * Notify the map that styles it draws colors from may have been updated. + * Notify the map that styles it draws colors from may have been updated. */ styleUpdated(): Object; /** - * Resets the zoom level of the map to default. + * Resets the zoom level of the map to default. */ resetZoom(): Object; /** - * Adds a new item to the data source and notifies the map. + * Adds a new item to the data source and notifies the map. * * @param item The item that we want to add to the data source. * @param targetName The name of the series bound to the data source. @@ -56228,7 +56228,7 @@ interface IgMapMethods { addItem(item: Object, targetName: string): void; /** - * Inserts a new item to the data source and notifies the map. + * Inserts a new item to the data source and notifies the map. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -56237,7 +56237,7 @@ interface IgMapMethods { insertItem(item: Object, index: number, targetName: string): void; /** - * Deletes an item from the data source and notifies the map. + * Deletes an item from the data source and notifies the map. * * @param index The index in the data source from where the item will be been removed. * @param targetName The name of the series bound to the data source. @@ -56245,7 +56245,7 @@ interface IgMapMethods { removeItem(index: number, targetName: string): void; /** - * Updates an item in the data source and notifies the map. + * Updates an item in the data source and notifies the map. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -56254,7 +56254,7 @@ interface IgMapMethods { setItem(index: number, item: Object, targetName: string): void; /** - * Notifies the the map that an item has been set in an associated data source. + * Notifies the the map that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -56264,7 +56264,7 @@ interface IgMapMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the the map that the items have been cleared from an associated data source. + * Notifies the the map that the items have been cleared from an associated data source. * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. @@ -56272,7 +56272,7 @@ interface IgMapMethods { notifyClearItems(dataSource: Object): Object; /** - * Notifies the the target series that an item has been inserted at the specified index in its data source. + * Notifies the the target series that an item has been inserted at the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. @@ -56282,7 +56282,7 @@ interface IgMapMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the the target series that an item has been removed from the specified index in its data source. + * Notifies the the target series that an item has been removed from the specified index in its data source. * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. @@ -56292,7 +56292,7 @@ interface IgMapMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Notifies the target series or axis that it should scroll the requested data item into view. + * Notifies the target series or axis that it should scroll the requested data item into view. * * @param targetName The name of the series or axis notify. * @param item The data item to bring into view, if possible. @@ -56300,8 +56300,8 @@ interface IgMapMethods { scrollIntoView(targetName: string, item: Object): Object; /** - * Either xAxis or yAxis (longitude or latitude) that it should scale the requested value into map space from axis space. - * For example you can use this method if you want to find where longitude 50 stands scaled to map's width. + * Either xAxis or yAxis (longitude or latitude) that it should scale the requested value into map space from axis space. + * For example you can use this method if you want to find where longitude 50 stands scaled to map's width. * * @param targetName Either xAxis or yAxis to notify. * @param unscaledValue The value in axis space to translate into map space. @@ -56309,8 +56309,8 @@ interface IgMapMethods { scaleValue(targetName: string, unscaledValue: number): number; /** - * Either xAxis or yAxis (longitude or latitude) that it should unscale the requested value into axis space from map space. - * For example you can use this method if you want to find what is the longitude unscaled from 0 width of the map. + * Either xAxis or yAxis (longitude or latitude) that it should unscale the requested value into axis space from map space. + * For example you can use this method if you want to find what is the longitude unscaled from 0 width of the map. * * @param targetName Either xAxis or yAxis to notify. * @param scaledValue The value in map space to translate into axis space. @@ -56318,77 +56318,77 @@ interface IgMapMethods { unscaleValue(targetName: string, scaledValue: number): number; /** - * Manually starts a tiled zoom if one isn't already running. + * Manually starts a tiled zoom if one isn't already running. */ startTiledZoomingIfNecessary(): void; /** - * Manually ends a tiled zoom if one is running. + * Manually ends a tiled zoom if one is running. */ endTiledZoomingIfRunning(): void; /** - * Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.. + * Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.. */ clearTileZoomCache(): void; /** - * Forces any pending deferred work to render on the map before continuing + * Forces any pending deferred work to render on the map before continuing */ flush(): void; /** - * Exports visual data from the map to aid in unit testing + * Exports visual data from the map to aid in unit testing */ exportVisualData(): void; /** - * Gets the actual minimum value of the target xAxis or yAxis + * Gets the actual minimum value of the target xAxis or yAxis * * @param targetName */ getActualMinimumValue(targetName: Object): void; /** - * Gets the actual maximum value of the target xAxis or yAxis + * Gets the actual maximum value of the target xAxis or yAxis * * @param targetName */ getActualMaximumValue(targetName: Object): void; /** - * Notifies the map that the container was resized + * Notifies the map that the container was resized */ notifyContainerResized(): void; /** - * Zoom in to the geographic region specified, when possible (may need to wait fior map to be initialized). + * Zoom in to the geographic region specified, when possible (may need to wait fior map to be initialized). * * @param rect The geographic area rectangle. */ zoomToGeographic(rect: Object): Object; /** - * Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. + * Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. * * @param rect The geographic area rectangle. */ getGeographicFromZoom(rect: Object): Object; /** - * Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. + * Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. * * @param rect The geographic area rectangle. */ getZoomFromGeographic(rect: Object): Object; /** - * Creates a print preview page with the map, hiding all other elements on the page. + * Creates a print preview page with the map, hiding all other elements on the page. */ print(): void; /** - * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. + * Indicates that a series should render, even though no option has been modified that would normally cause it to refresh. * * @param targetName The name of the series to render. * @param animate Whether the change should be animated, if possible. @@ -56401,56 +56401,56 @@ interface JQuery { interface ShapeDataSourceSettings { /** - * The unique identifier. + * The unique identifier. */ id?: string; /** - * The Uri of the .shp portion of the Shapefile. + * The Uri of the .shp portion of the Shapefile. */ shapefileSource?: string; /** - * The Uri of the .dbf portion of the Shapefile. + * The Uri of the .dbf portion of the Shapefile. */ databaseSource?: string; /** - * Callback function to call when data binding is complete. + * Callback function to call when data binding is complete. */ callback?: Function; /** - * Object on which to invoke the callback function. + * Object on which to invoke the callback function. */ callee?: any; /** - * Callback function to call to allow shape records to be transformed. + * Callback function to call to allow shape records to be transformed. * paramType="object" the shape record to be transformed. */ transformRecord?: Function; /** - * Callback function to call to allow points in the shape records to be transformed. + * Callback function to call to allow points in the shape records to be transformed. * paramType="object" the point to be transformed in place. The object will look like { x: value, y: value2 } */ transformPoint?: Function; /** - * Callback function to call to allow the bounds of the shape data source to be transformed. + * Callback function to call to allow the bounds of the shape data source to be transformed. * paramType="object" the bounds of the shape datasource to be transformed in place. The object will look like { top: value, left: value, width: value, height: value } */ transformBounds?: Function; /** - * Callback function to call when the import process has been completed + * Callback function to call when the import process has been completed * paramType="object" the ShapeDataSource instance */ importCompleted?: Function; /** - * Option for ShapeDataSourceSettings + * Option for ShapeDataSourceSettings */ [optionName: string]: any; } @@ -56481,32 +56481,32 @@ interface IgniteUIStatic { interface TriangulationDataSourceSettings { /** - * The unique identifier. + * The unique identifier. */ id?: string; /** - * A Uri specifying the location of the Itf file. + * A Uri specifying the location of the Itf file. */ source?: string; /** - * The TriangulationSource which is typically created after importing the Itf from the Source Uri. + * The TriangulationSource which is typically created after importing the Itf from the Source Uri. */ triangulationSource?: string; /** - * Callback function to call when data binding is complete + * Callback function to call when data binding is complete */ callback?: Function; /** - * Object on which to invoke the callback function + * Object on which to invoke the callback function */ callee?: any; /** - * Option for TriangulationDataSourceSettings + * Option for TriangulationDataSourceSettings */ [optionName: string]: any; } @@ -57517,33 +57517,33 @@ interface IgNotifierMessages { error?: string; /** - * Option for IgNotifierMessages + * Option for IgNotifierMessages */ [optionName: string]: any; } interface IgNotifierHeaderTemplate { /** - * Controls whether the popover renders a functional close button + * Controls whether the popover renders a functional close button * */ closeButton?: boolean; /** - * Sets the content for the popover header. + * Sets the content for the popover header. * */ title?: string; /** - * Option for IgNotifierHeaderTemplate + * Option for IgNotifierHeaderTemplate */ [optionName: string]: any; } interface IgNotifier { /** - * Gets/Sets the current state of the igNotifier messages. State controls what CSS classes are applied to the messages and target and has interactions with other options as well. + * Gets/Sets the current state of the igNotifier messages. State controls what CSS classes are applied to the messages and target and has interactions with other options as well. * * * Valid values: @@ -57555,7 +57555,7 @@ interface IgNotifier { state?: string; /** - * Controls the level of notifications shown by automatic and manual messages using the [notify](ui.ignotifier#methods:notify) method. Use [show](ui.ignotifier#methods:show) to ignore the level. + * Controls the level of notifications shown by automatic and manual messages using the [notify](ui.ignotifier#methods:notify) method. Use [show](ui.ignotifier#methods:show) to ignore the level. * * * Valid values: @@ -57567,7 +57567,7 @@ interface IgNotifier { notifyLevel?: string; /** - * Controls where the popover DOM should be attached to (only applies to popovers). + * Controls where the popover DOM should be attached to (only applies to popovers). * * * Valid values: @@ -57577,7 +57577,7 @@ interface IgNotifier { appendTo?: string|Object; /** - * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. + * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. * * * @@ -57589,25 +57589,25 @@ interface IgNotifier { mode?: string; /** - * Allows setting the respective state CSS on the target element (used to apply border color by default) + * Allows setting the respective state CSS on the target element (used to apply border color by default) * */ allowCSSOnTarget?: boolean; /** - * A set of default messages for each state + * A set of default messages for each state * */ messages?: IgNotifierMessages; /** - * Allows rendering a span with the respective state CSS to display jQuery UI framework icons + * Allows rendering a span with the respective state CSS to display jQuery UI framework icons * */ showIcon?: boolean; /** - * Gets/Sets the content for the popover container. Templated with parameters by default: {0} - icon container class, {1} - the icon class and {2} - message text. + * Gets/Sets the content for the popover container. Templated with parameters by default: {0} - icon container class, {1} - the icon class and {2} - message text. * * * Valid values: @@ -57617,13 +57617,13 @@ interface IgNotifier { contentTemplate?: string|Function; /** - * Sets the content for the popover header + * Sets the content for the popover header * */ headerTemplate?: IgNotifierHeaderTemplate; /** - * Sets the event on which the notification will be shown. Predefined values are "mouseenter", "click" and "focus" + * Sets the event on which the notification will be shown. Predefined values are "mouseenter", "click" and "focus" * * * Valid values: @@ -57635,30 +57635,30 @@ interface IgNotifier { showOn?: string; /** - * Controls whether the popover will close on blur or not. This option has effect only when the corresponding [showOn](ui.ignotifier#options:showOn) is set (manual by default) + * Controls whether the popover will close on blur or not. This option has effect only when the corresponding [showOn](ui.ignotifier#options:showOn) is set (manual by default) * */ closeOnBlur?: boolean; /** - * Gets/Sets the time in milliseconds the notification fades in and out when showing/hiding + * Gets/Sets the time in milliseconds the notification fades in and out when showing/hiding * */ animationDuration?: number; /** - * Gets/Sets the distance in pixels a notification popover slides outwards as it's shown. + * Gets/Sets the distance in pixels a notification popover slides outwards as it's shown. * */ animationSlideDistance?: number; /** - * Selectors indicating which items should show popovers. + * Selectors indicating which items should show popovers. */ selectors?: string; /** - * controls the direction in which the control shows relative to the target element + * controls the direction in which the control shows relative to the target element * * Valid values: * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left @@ -57670,7 +57670,7 @@ interface IgNotifier { direction?: string; /** - * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area + * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * * Valid values: * "auto" lets the control choose a position depending on available space with the following priority balanced > end > start @@ -57681,37 +57681,37 @@ interface IgNotifier { position?: string; /** - * defines width for the popover. leave null for auto. + * defines width for the popover. leave null for auto. */ width?: number|string; /** - * defines height for the popover. leave null for auto + * defines height for the popover. leave null for auto */ height?: number|string; /** - * defines width the popover won't go under the value even if no specific one is set. + * defines width the popover won't go under the value even if no specific one is set. */ minWidth?: number|string; /** - * defines width the popover won't exceed even if no specific one is set. + * defines width the popover won't exceed even if no specific one is set. */ maxWidth?: number|string; /** - * defines height the popover won't exceed even if no specific one is set. + * defines height the popover won't exceed even if no specific one is set. */ maxHeight?: number|string; /** - * Sets the containment for the popover. Accepts a jQuery object + * Sets the containment for the popover. Accepts a jQuery object */ containment?: any; /** - * Event fired before popover is shown. + * Event fired before popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will show for. * Use ui.content to get or set the content to be shown as a string. @@ -57721,7 +57721,7 @@ interface IgNotifier { showing?: ShowingEvent; /** - * Event fired after popover is shown. + * Event fired after popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover showed for. * Use ui.content to get the content that was shown as a string. @@ -57731,7 +57731,7 @@ interface IgNotifier { shown?: ShownEvent; /** - * Event fired before popover is hidden. + * Event fired before popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will hide for. * Use ui.content to get the current content displayed in the popover as a string. @@ -57741,7 +57741,7 @@ interface IgNotifier { hiding?: HidingEvent; /** - * Event fired after popover is hidden. + * Event fired after popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover is hidden for. * Use ui.content to get the content displayed in the popover as a string. @@ -57751,13 +57751,13 @@ interface IgNotifier { hidden?: HiddenEvent; /** - * Option for igNotifier + * Option for igNotifier */ [optionName: string]: any; } interface IgNotifierMethods { /** - * Triggers a notification with a certain state and optional message. The [notifyLevel](ui.ignotifier#options:notifyLevel) option determines if the notification will be displayed. + * Triggers a notification with a certain state and optional message. The [notifyLevel](ui.ignotifier#options:notifyLevel) option determines if the notification will be displayed. * * @param state The state to show notification for. * @param message Optional message to show, overrides defaults. @@ -57765,27 +57765,27 @@ interface IgNotifierMethods { notify(state: Object, message?: string): void; /** - * Returns true if the notification is currently visible + * Returns true if the notification is currently visible */ isVisible(): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Returns the ID of the element the popover is attached to + * Returns the ID of the element the popover is attached to */ id(): string; /** - * Returns the container for the popover contents + * Returns the container for the popover contents */ container(): Object; /** - * Shows the popover for the specified target + * Shows the popover for the specified target * * @param trg The element to show popover for. * @param content The string to set for the popover to show. @@ -57793,34 +57793,34 @@ interface IgNotifierMethods { show(trg?: Element, content?: string): void; /** - * Hides the popover for the specified target + * Hides the popover for the specified target */ hide(): void; /** - * Gets the currently set content for the popover container + * Gets the currently set content for the popover container */ getContent(): string; /** - * Sets the content for the popover container + * Sets the content for the popover container * * @param newCnt The popover content to set. */ setContent(newCnt: string): void; /** - * Gets the popover current target + * Gets the popover current target */ target(): Object; /** - * Gets the current coordinates of the popover + * Gets the current coordinates of the popover */ getCoordinates(): Object; /** - * Sets the popover to specific coordinates. + * Sets the popover to specific coordinates. * * @param pos The popover coordinates in pixels. */ @@ -58231,380 +58231,380 @@ interface JQuery { } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions { /** - * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. + * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest * and will prompt the user for credentials. */ withCredentials?: boolean; /** - * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax’s options object. + * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax’s options object. */ beforeSend?: Function; /** - * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions + * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings { /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ nonEmptyOnRows?: boolean; /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true */ nonEmptyOnColumns?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnRows?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnColumns?: boolean; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnRows?: any[]; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnColumns?: any[]; /** - * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings + * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsXmlaOptions { /** - * Optional="false" The URL of the XMLA server. + * Optional="false" The URL of the XMLA server. */ serverUrl?: string; /** - * The catalog name. + * The catalog name. */ catalog?: string; /** - * The name of the cube in the data source. + * The name of the cube in the data source. */ cube?: string; /** - * The name of the measure group in the data source. + * The name of the measure group in the data source. */ measureGroup?: string; /** - * An object containing information about how the request to the XMLA server should be processed. + * An object containing information about how the request to the XMLA server should be processed. */ requestOptions?: IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions; /** - * Enables/disables caching of the XMLA result object. + * Enables/disables caching of the XMLA result object. */ enableResultCache?: boolean; /** - * Additional properties sent with every discover request. + * Additional properties sent with every discover request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ discoverProperties?: any; /** - * Additional properties sent with every execute request. + * Additional properties sent with every execute request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ executeProperties?: any; /** - * Optional="true" a javascript object containing information about how the request to the xmla server should be processed + * Optional="true" a javascript object containing information about how the request to the xmla server should be processed */ mdxSettings?: IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings; /** - * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptions + * Option for IgPivotDataSelectorDataSourceOptionsXmlaOptions */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { /** - * Optional="false" A unique name for the measure. + * Optional="false" A unique name for the measure. */ name?: string; /** - * A caption for the measure. + * A caption for the measure. */ caption?: string; /** - * Optional="false" An aggregator function called when each cell is evaluated. + * Optional="false" An aggregator function called when each cell is evaluated. * Returns a value for the cell. If the returned value is null, no cell will be created in for the data source result. */ aggregator?: Function; /** - * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). + * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). */ displayFolder?: string; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { /** - * A unique name for the measures dimension. + * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: * [].[] */ name?: string; /** - * A caption for the measures dimension. + * A caption for the measures dimension. * The default value is "Measures". */ caption?: string; /** - * An array of measure metadata objects. + * An array of measure metadata objects. */ measures?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure[]; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { /** - * Optional="false" A name for the level. + * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: * {}.[] */ name?: string; /** - * A caption for the level. + * A caption for the level. */ caption?: string; /** - * A function called for each item of the data source array when level members are created. + * A function called for each item of the data source array when level members are created. * Based on the item parameter the function should return a value that will form the $.ig.Member’s name and caption. */ memberProvider?: Function; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { /** - * Optional="false" A name for the hierarchy. + * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: * [].[] */ name?: string; /** - * A caption for the hierarchy. + * A caption for the hierarchy. */ caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. + * The path to be used when displaying the hierarchy in the user interface. * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; /** - * An array of level metadata objects. + * An array of level metadata objects. */ levels?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel[]; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension { /** - * Optional="false" A unique name for the dimension. + * Optional="false" A unique name for the dimension. */ name?: string; /** - * A caption for the dimension. + * A caption for the dimension. */ caption?: string; /** - * An array of hierarchy metadata objects. + * An array of hierarchy metadata objects. */ hierarchies?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie[]; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube { /** - * Optional="false" A unique name for the cube. + * Optional="false" A unique name for the cube. */ name?: string; /** - * A caption for the cube. + * A caption for the cube. */ caption?: string; /** - * An object providing information about the measures' root node. + * An object providing information about the measures' root node. */ measuresDimension?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension; /** - * An array of dimension metadata objects. + * An array of dimension metadata objects. */ dimensions?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension[]; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata { /** - * Optional="false" Metadata used for the creation of the cube. + * Optional="false" Metadata used for the creation of the cube. */ cube?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { /** - * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. + * See $.ig.DataSource. * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; /** - * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. * null Option is ignored. */ responseDataType?: string; /** - * Optional="false" An object containing processing instructions for the $.ig.DataSource data. + * Optional="false" An object containing processing instructions for the $.ig.DataSource data. */ metadata?: IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata; /** - * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptions + * Option for IgPivotDataSelectorDataSourceOptionsFlatDataOptions */ [optionName: string]: any; } interface IgPivotDataSelectorDataSourceOptions { /** - * Settings for creating an instance of $.ig.OlapXmlaDataSource. + * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ xmlaOptions?: IgPivotDataSelectorDataSourceOptionsXmlaOptions; /** - * Settings for creating an instance of $.ig.OlapFlatDataSource. + * Settings for creating an instance of $.ig.OlapFlatDataSource. */ flatDataOptions?: IgPivotDataSelectorDataSourceOptionsFlatDataOptions; /** - * A list of measure names separated by comma (,). These will be the measures of the data source. + * A list of measure names separated by comma (,). These will be the measures of the data source. */ measures?: string; /** - * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. + * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. */ filters?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. */ rows?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. */ columns?: string; /** - * Option for IgPivotDataSelectorDataSourceOptions + * Option for IgPivotDataSelectorDataSourceOptions */ [optionName: string]: any; } interface IgPivotDataSelectorDragAndDropSettings { /** - * Which element the draggable helper should be appended to while dragging. + * Which element the draggable helper should be appended to while dragging. */ appendTo?: any; /** - * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. + * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. * */ containment?: boolean|string|Array; /** - * Specifies z-index that would be set for the drag helper. + * Specifies z-index that would be set for the drag helper. */ zIndex?: number; /** - * Option for IgPivotDataSelectorDragAndDropSettings + * Option for IgPivotDataSelectorDragAndDropSettings */ [optionName: string]: any; } @@ -58615,7 +58615,7 @@ interface DataSelectorRenderedEvent { interface DataSelectorRenderedEventUIParam { /** - * Used to get a reference to the data selector. + * Used to get a reference to the data selector. */ owner?: any; } @@ -58626,22 +58626,22 @@ interface DataSourceInitializedEvent { interface DataSourceInitializedEventUIParam { /** - * Used to get a reference to the data selector. + * Used to get a reference to the data selector. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to see if an error has occured during initialization. + * Used to see if an error has occured during initialization. */ error?: any; /** - * Used to get a reference to the root of the data source metatadata root item. + * Used to get a reference to the root of the data source metatadata root item. */ metadataTreeRoot?: any; } @@ -58652,22 +58652,22 @@ interface DataSourceUpdatedEvent { interface DataSourceUpdatedEventUIParam { /** - * Used to get a reference to the data selector. + * Used to get a reference to the data selector. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to see if an error has occured during update. + * Used to see if an error has occured during update. */ error?: any; /** - * Used to get the result of the update operation. + * Used to get the result of the update operation. */ result?: any; } @@ -58678,12 +58678,12 @@ interface DeferUpdateChangedEvent { interface DeferUpdateChangedEventUIParam { /** - * Used to get a reference to the data selector. + * Used to get a reference to the data selector. */ owner?: any; /** - * Used to get the defer update value. + * Used to get the defer update value. */ deferUpdate?: any; } @@ -58694,27 +58694,27 @@ interface DragStartEvent { interface DragStartEventUIParam { /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; /** - * Used to get a reference to the helper. + * Used to get a reference to the helper. */ helper?: any; /** - * Used to get a reference to the offset. + * Used to get a reference to the offset. */ offset?: any; /** - * Used to get a reference to the original position of the draggable element. + * Used to get a reference to the original position of the draggable element. */ originalPosition?: any; /** - * Used to get a reference to the current position of the draggable element. + * Used to get a reference to the current position of the draggable element. */ position?: any; } @@ -58725,27 +58725,27 @@ interface DragEvent { interface DragEventUIParam { /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; /** - * Used to get a reference to the helper. + * Used to get a reference to the helper. */ helper?: any; /** - * Used to get a reference to the offset. + * Used to get a reference to the offset. */ offset?: any; /** - * Used to get a reference to the original position of the draggable element. + * Used to get a reference to the original position of the draggable element. */ originalPosition?: any; /** - * Used to get a reference to the current position of the draggable element. + * Used to get a reference to the current position of the draggable element. */ position?: any; } @@ -58756,22 +58756,22 @@ interface DragStopEvent { interface DragStopEventUIParam { /** - * Used to get a reference to the helper. + * Used to get a reference to the helper. */ helper?: any; /** - * Used to get a reference to the offset. + * Used to get a reference to the offset. */ offset?: any; /** - * Used to get a reference to the original position of the draggable element. + * Used to get a reference to the original position of the draggable element. */ originalPosition?: any; /** - * Used to get a reference to the current position of the draggable element. + * Used to get a reference to the current position of the draggable element. */ position?: any; } @@ -58782,37 +58782,37 @@ interface MetadataDroppingEvent { interface MetadataDroppingEventUIParam { /** - * Used to the drop target. + * Used to the drop target. */ targetElement?: any; /** - * Used to the dragged element. + * Used to the dragged element. */ draggedElement?: any; /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; /** - * Used to get the index at which the metadata will be inserted. + * Used to get the index at which the metadata will be inserted. */ metadataIndex?: any; /** - * Used to get a reference to the helper. + * Used to get a reference to the helper. */ helper?: any; /** - * Used to get a reference to the offset. + * Used to get a reference to the offset. */ offset?: any; /** - * Used to get a reference to the current position of the draggable element. + * Used to get a reference to the current position of the draggable element. */ position?: any; } @@ -58823,37 +58823,37 @@ interface MetadataDroppedEvent { interface MetadataDroppedEventUIParam { /** - * Used to the drop target. + * Used to the drop target. */ targetElement?: any; /** - * Used to the dragged element. + * Used to the dragged element. */ draggedElement?: any; /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; /** - * Used to get the index at which the metadata is inserted. + * Used to get the index at which the metadata is inserted. */ metadataIndex?: any; /** - * Used to get a reference to the helper. + * Used to get a reference to the helper. */ helper?: any; /** - * Used to get a reference to the offset. + * Used to get a reference to the offset. */ offset?: any; /** - * Used to get a reference to the current position of the draggable element. + * Used to get a reference to the current position of the draggable element. */ position?: any; } @@ -58864,12 +58864,12 @@ interface MetadataRemovingEvent { interface MetadataRemovingEventUIParam { /** - * Used to the dragged element. + * Used to the dragged element. */ targetElement?: any; /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; } @@ -58880,7 +58880,7 @@ interface MetadataRemovedEvent { interface MetadataRemovedEventUIParam { /** - * Used to get a reference to the data. + * Used to get a reference to the data. */ metadata?: any; } @@ -58891,7 +58891,7 @@ interface FilterDropDownOpeningEvent { interface FilterDropDownOpeningEventUIParam { /** - * Used to the hierarchy. + * Used to the hierarchy. */ hierarchy?: any; } @@ -58902,12 +58902,12 @@ interface FilterDropDownOpenedEvent { interface FilterDropDownOpenedEventUIParam { /** - * Used to the hierarchy. + * Used to the hierarchy. */ hierarchy?: any; /** - * Used to the drop down. + * Used to the drop down. */ dropDownElement?: any; } @@ -58918,7 +58918,7 @@ interface FilterMembersLoadedEvent { interface FilterMembersLoadedEventUIParam { /** - * Used to get the parent node or the igTree instance in the initial load. + * Used to get the parent node or the igTree instance in the initial load. */ parent?: any; rootFilterMembers?: any; @@ -58931,13 +58931,13 @@ interface FilterDropDownOkEvent { interface FilterDropDownOkEventUIParam { /** - * Used to the hierarchy. + * Used to the hierarchy. */ hierarchy?: any; filterMembers?: any; /** - * Used to the drop down. + * Used to the drop down. */ dropDownElement?: any; } @@ -58948,12 +58948,12 @@ interface FilterDropDownClosingEvent { interface FilterDropDownClosingEventUIParam { /** - * Used to the hierarchy. + * Used to the hierarchy. */ hierarchy?: any; /** - * Used to the drop down. + * Used to the drop down. */ dropDownElement?: any; } @@ -58964,7 +58964,7 @@ interface FilterDropDownClosedEvent { interface FilterDropDownClosedEventUIParam { /** - * Used to the hierarchy. + * Used to the hierarchy. */ hierarchy?: any; } @@ -58973,7 +58973,7 @@ interface IgPivotDataSelector { width?: string|number; /** - * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. + * This is the total height of the grid, including all UI elements - scroll container with data rows, header, footer, filter row - (if any), etc. * * Valid values: * "string" The widget height can be set in pixels (px) and percentage (%). @@ -58983,53 +58983,53 @@ interface IgPivotDataSelector { height?: string|number; /** - * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. */ dataSource?: any; /** - * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. * The provided value must contain an object with settings for one of the data source types - xmlaOptions or flatDataOptions. */ dataSourceOptions?: IgPivotDataSelectorDataSourceOptions; /** - * Setting deferUpdate to true will not apply changes to the data source until the update method is called or the update layout button is clicked. + * Setting deferUpdate to true will not apply changes to the data source until the update method is called or the update layout button is clicked. */ deferUpdate?: boolean; /** - * Settings for the drag and drop functionality of the igPivotDataSelector. + * Settings for the drag and drop functionality of the igPivotDataSelector. */ dragAndDropSettings?: IgPivotDataSelectorDragAndDropSettings; /** - * Specifies the parent for the drop downs. + * Specifies the parent for the drop downs. */ dropDownParent?: any; /** - * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. */ disableRowsDropArea?: boolean; /** - * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. */ disableColumnsDropArea?: boolean; /** - * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. */ disableMeasuresDropArea?: boolean; /** - * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. */ disableFiltersDropArea?: boolean; /** - * A function that will be called to determine if an item can be moved in or dropped on an area of the data selector. + * A function that will be called to determine if an item can be moved in or dropped on an area of the data selector. * paramType="string" The location where the item will be moved - igPivotGrid, igPivotDataSelector, filters, rows, columns or measures. * paramType="string" The type of the item - Hierarchy, Measure or MeasureList. * paramType="string" The unique name of the item. @@ -59038,14 +59038,14 @@ interface IgPivotDataSelector { customMoveValidation?: Function; /** - * Fired after the data selector is rendered. Changing the data source instance will re-render the data selector. + * Fired after the data selector is rendered. Changing the data source instance will re-render the data selector. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the data selector. */ dataSelectorRendered?: DataSelectorRenderedEvent; /** - * Fired after the data source has initialized. + * Fired after the data source has initialized. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the data selector. * Use ui.dataSource to get a reference to the data source. @@ -59055,7 +59055,7 @@ interface IgPivotDataSelector { dataSourceInitialized?: DataSourceInitializedEvent; /** - * Fired after the data source has updated. + * Fired after the data source has updated. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the data selector. * Use ui.dataSource to get a reference to the data source. @@ -59065,7 +59065,7 @@ interface IgPivotDataSelector { dataSourceUpdated?: DataSourceUpdatedEvent; /** - * Fired when the defer update checkbox changes. + * Fired when the defer update checkbox changes. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the data selector. * Use ui.deferUpdate to get the defer update value. @@ -59073,7 +59073,7 @@ interface IgPivotDataSelector { deferUpdateChanged?: DeferUpdateChangedEvent; /** - * Fired on drag start. Return false to cancel the drag. + * Fired on drag start. Return false to cancel the drag. * Use ui.metadatato get a reference to the data. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. @@ -59083,7 +59083,7 @@ interface IgPivotDataSelector { dragStart?: DragStartEvent; /** - * Fired on drag. Return false to cancel the dragging. + * Fired on drag. Return false to cancel the dragging. * Use ui.metadatato get a reference to the data. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. @@ -59093,7 +59093,7 @@ interface IgPivotDataSelector { drag?: DragEvent; /** - * Fired on drag stop. + * Fired on drag stop. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. * Use ui.originalPosition to get a reference to the original position of the draggable element. @@ -59102,7 +59102,7 @@ interface IgPivotDataSelector { dragStop?: DragStopEvent; /** - * Fired before a metadata item drop. Return false to cancel the drop. + * Fired before a metadata item drop. Return false to cancel the drop. * Use ui.targetElement for a reference to the drop target. * Use ui.draggedElement for a reference to the dragged element. * Use ui.metadatato get a reference to the data. @@ -59114,7 +59114,7 @@ interface IgPivotDataSelector { metadataDropping?: MetadataDroppingEvent; /** - * Fired after a metadata item drop. + * Fired after a metadata item drop. * Use ui.targetElement for a reference to the drop target. * Use ui.draggedElement for a reference to the dragged element. * Use ui.metadatato get a reference to the data. @@ -59126,33 +59126,33 @@ interface IgPivotDataSelector { metadataDropped?: MetadataDroppedEvent; /** - * Fired before a metadata item is removed when the user clicks the close icon. Return false to cancel the removing. + * Fired before a metadata item is removed when the user clicks the close icon. Return false to cancel the removing. * Use ui.targetElement for a reference to the dragged element. * Use ui.metadatato get a reference to the data. */ metadataRemoving?: MetadataRemovingEvent; /** - * Fired after a metadata item is removed when the user clicks the close icon. + * Fired after a metadata item is removed when the user clicks the close icon. * Use ui.metadatato get a reference to the data. */ metadataRemoved?: MetadataRemovedEvent; /** - * Fired before the filter members drop down opens. Return false to cancel the opening. + * Fired before the filter members drop down opens. Return false to cancel the opening. * Use ui.hierarchy for a reference to the hierarchy. */ filterDropDownOpening?: FilterDropDownOpeningEvent; /** - * Fired after the filter members drop down opens. + * Fired after the filter members drop down opens. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.dropDownElement for a reference to the drop down. */ filterDropDownOpened?: FilterDropDownOpenedEvent; /** - * Fired after the filter members are loaded. + * Fired after the filter members are loaded. * Use ui.parent to get the parent node or the igTree instance in the initial load. * Use ui.rootFilterMembers for a collection with the root filter members . * Use ui.filterMembers for a collection with the newly loaded filter members. @@ -59160,7 +59160,7 @@ interface IgPivotDataSelector { filterMembersLoaded?: FilterMembersLoadedEvent; /** - * Fired after the OK button in the filter members drop down is clicked. Return false to cancel the applying of the filters. + * Fired after the OK button in the filter members drop down is clicked. Return false to cancel the applying of the filters. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.filterMembers for a collection with the selected filter members. If all filter members are selected the collection will be empty. * Use ui.dropDownElement for a reference to the drop down. @@ -59168,31 +59168,31 @@ interface IgPivotDataSelector { filterDropDownOk?: FilterDropDownOkEvent; /** - * Fired before the filter members drop down closes. Return false to cancel the closing. + * Fired before the filter members drop down closes. Return false to cancel the closing. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.dropDownElement for a reference to the drop down. */ filterDropDownClosing?: FilterDropDownClosingEvent; /** - * Fired after the filter members drop down closes. + * Fired after the filter members drop down closes. * Use ui.hierarchy for a reference to the hierarchy. */ filterDropDownClosed?: FilterDropDownClosedEvent; /** - * Option for igPivotDataSelector + * Option for igPivotDataSelector */ [optionName: string]: any; } interface IgPivotDataSelectorMethods { /** - * Updates the data source. + * Updates the data source. */ update(): void; /** - * Destroy is part of the jQuery UI widget API and does the following: + * Destroy is part of the jQuery UI widget API and does the following: * 1. Remove custom CSS classes that were added. * 2. Unwrap any wrapping elements such as scrolling divs and other containers. * 3. Unbind all events that were bound. @@ -59684,374 +59684,374 @@ interface JQuery { } interface IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions { /** - * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. + * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest * and will prompt the user for credentials. */ withCredentials?: boolean; /** - * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax's options object. + * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax's options object. */ beforeSend?: Function; /** - * Option for IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions + * Option for IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings { /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ nonEmptyOnRows?: boolean; /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true */ nonEmptyOnColumns?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnRows?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnColumns?: boolean; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnRows?: any[]; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnColumns?: any[]; /** - * Option for IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings + * Option for IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsXmlaOptions { /** - * Optional="false" The URL of the XMLA server. + * Optional="false" The URL of the XMLA server. */ serverUrl?: string; /** - * The catalog name. + * The catalog name. */ catalog?: string; /** - * The name of the cube in the data source. + * The name of the cube in the data source. */ cube?: string; /** - * The name of the measure group in the data source. + * The name of the measure group in the data source. */ measureGroup?: string; /** - * An object containing information about how the request to the XMLA server should be processed. + * An object containing information about how the request to the XMLA server should be processed. */ requestOptions?: IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions; /** - * Enables/disables caching of the XMLA result object. + * Enables/disables caching of the XMLA result object. */ enableResultCache?: boolean; /** - * Additional properties sent with every discover request. + * Additional properties sent with every discover request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ discoverProperties?: any; /** - * Additional properties sent with every execute request. + * Additional properties sent with every execute request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ executeProperties?: any; /** - * Optional="true" a javascript object containing information about how the request to the xmla server should be processed + * Optional="true" a javascript object containing information about how the request to the xmla server should be processed */ mdxSettings?: IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings; /** - * Option for IgPivotGridDataSourceOptionsXmlaOptions + * Option for IgPivotGridDataSourceOptionsXmlaOptions */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { /** - * Optional="false" A unique name for the measure. + * Optional="false" A unique name for the measure. */ name?: string; /** - * A caption for the measure. + * A caption for the measure. */ caption?: string; /** - * Optional="false" An aggregator function called when each cell is evaluated. + * Optional="false" An aggregator function called when each cell is evaluated. * Returns a value for the cell. If the returned value is null, no cell will be created in for the data source result. */ aggregator?: Function; /** - * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). + * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). */ displayFolder?: string; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { /** - * A unique name for the measures dimension. + * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: * [].[] */ name?: string; /** - * A caption for the measures dimension. + * A caption for the measures dimension. * The default value is "Measures". */ caption?: string; /** - * An array of measure metadata objects. + * An array of measure metadata objects. */ measures?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure[]; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { /** - * Optional="false" A name for the level. + * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: * {}.[] */ name?: string; /** - * A caption for the level. + * A caption for the level. */ caption?: string; /** - * A function called for each item of the data source array when level members are created. + * A function called for each item of the data source array when level members are created. * Based on the item parameter the function should return a value that will form the $.ig.Member's name and caption. */ memberProvider?: Function; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { /** - * Optional="false" A name for the hierarchy. + * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: * [].[] */ name?: string; /** - * A caption for the hierarchy. + * A caption for the hierarchy. */ caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. + * The path to be used when displaying the hierarchy in the user interface. * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; /** - * An array of level metadata objects. + * An array of level metadata objects. */ levels?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel[]; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension { /** - * Optional="false" A unique name for the dimension. + * Optional="false" A unique name for the dimension. */ name?: string; /** - * A caption for the dimension. + * A caption for the dimension. */ caption?: string; /** - * An array of hierarchy metadata objects. + * An array of hierarchy metadata objects. */ hierarchies?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie[]; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube { /** - * Optional="false" A unique name for the cube. + * Optional="false" A unique name for the cube. */ name?: string; /** - * A caption for the cube. + * A caption for the cube. */ caption?: string; /** - * An object providing information about the measures' root node. + * An object providing information about the measures' root node. */ measuresDimension?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension; /** - * An array of dimension metadata objects. + * An array of dimension metadata objects. */ dimensions?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension[]; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadata { /** - * Optional="false" Metadata used for the creation of the cube. + * Optional="false" Metadata used for the creation of the cube. */ cube?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadata + * Option for IgPivotGridDataSourceOptionsFlatDataOptionsMetadata */ [optionName: string]: any; } interface IgPivotGridDataSourceOptionsFlatDataOptions { /** - * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. + * See $.ig.DataSource. * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; /** - * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. * null Option is ignored. */ responseDataType?: string; /** - * Optional="false" An object containing processing instructions for the $.ig.DataSource data. + * Optional="false" An object containing processing instructions for the $.ig.DataSource data. */ metadata?: IgPivotGridDataSourceOptionsFlatDataOptionsMetadata; /** - * Option for IgPivotGridDataSourceOptionsFlatDataOptions + * Option for IgPivotGridDataSourceOptionsFlatDataOptions */ [optionName: string]: any; } interface IgPivotGridDataSourceOptions { /** - * Settings for creating an instance of $.ig.OlapXmlaDataSource. + * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ xmlaOptions?: IgPivotGridDataSourceOptionsXmlaOptions; /** - * Settings for creating an instance of $.ig.OlapFlatDataSource. + * Settings for creating an instance of $.ig.OlapFlatDataSource. */ flatDataOptions?: IgPivotGridDataSourceOptionsFlatDataOptions; /** - * A list of measure names separated by comma (,). These will be the measures of the data source. + * A list of measure names separated by comma (,). These will be the measures of the data source. */ measures?: string; /** - * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. + * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. */ filters?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. */ rows?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. */ columns?: string; /** - * Option for IgPivotGridDataSourceOptions + * Option for IgPivotGridDataSourceOptions */ [optionName: string]: any; } interface IgPivotGridLevelSortDirection { /** - * Specifies the unique name of the level, which will be sorted. + * Specifies the unique name of the level, which will be sorted. */ levelUniqueName?: string; /** - * optional="true" Specifies the sort direction. If no direction is specified, the level is going to be sorted in the direction specified by the firstLevelSortDirection option. + * optional="true" Specifies the sort direction. If no direction is specified, the level is going to be sorted in the direction specified by the firstLevelSortDirection option. */ sortDirection?: any; /** - * optional="true" Specifies what type of sorting will be applied to the header cells. If no behavior is specified, the level is going to be sorted with the behavior specified in the defaultLevelSortBehavior option. + * optional="true" Specifies what type of sorting will be applied to the header cells. If no behavior is specified, the level is going to be sorted with the behavior specified in the defaultLevelSortBehavior option. * * Valid values: * "system" Sorts the headers by a specified sort key. @@ -60060,79 +60060,79 @@ interface IgPivotGridLevelSortDirection { sortBehavior?: string; /** - * Option for IgPivotGridLevelSortDirection + * Option for IgPivotGridLevelSortDirection */ [optionName: string]: any; } interface IgPivotGridGridOptionsFeatures { /** - * Option for IgPivotGridGridOptionsFeatures + * Option for IgPivotGridGridOptionsFeatures */ [optionName: string]: any; } interface IgPivotGridGridOptions { /** - * Default column width that will be set for all columns. + * Default column width that will be set for all columns. */ defaultColumnWidth?: string|number; /** - * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. */ fixedHeaders?: boolean; /** - * Caption text that will be shown above the pivot grid header. + * Caption text that will be shown above the pivot grid header. */ caption?: string; /** - * A list of grid features definitions. The supported features are Resizing and Tooltips. Each feature goes with its separate options that are documented for the feature accordingly. + * A list of grid features definitions. The supported features are Resizing and Tooltips. Each feature goes with its separate options that are documented for the feature accordingly. */ features?: IgPivotGridGridOptionsFeatures; /** - * Initial tabIndex attribute that will be set on the container element. + * Initial tabIndex attribute that will be set on the container element. */ tabIndex?: number; /** - * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). Note that if a custom jQuery template is set, this has no effect and CSS for the row should be adjusted manually in the template contents. + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). Note that if a custom jQuery template is set, this has no effect and CSS for the row should be adjusted manually in the template contents. */ alternateRowStyles?: boolean; /** - * Enables/disables rendering of ui-state-hover classes when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * Enables/disables rendering of ui-state-hover classes when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. */ enableHoverStyles?: boolean; /** - * Option for IgPivotGridGridOptions + * Option for IgPivotGridGridOptions */ [optionName: string]: any; } interface IgPivotGridDragAndDropSettings { /** - * Which element the draggable helper should be appended to while dragging. + * Which element the draggable helper should be appended to while dragging. */ appendTo?: any; /** - * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. + * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. * */ containment?: boolean|string|Array; /** - * Specifies z-index that would be set for the drag helper. + * Specifies z-index that would be set for the drag helper. */ zIndex?: number; /** - * Option for IgPivotGridDragAndDropSettings + * Option for IgPivotGridDragAndDropSettings */ [optionName: string]: any; } @@ -60143,17 +60143,17 @@ interface PivotGridHeadersRenderedEvent { interface PivotGridHeadersRenderedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get a reference to the igGrid widget, which holds the headers. + * Used to get a reference to the igGrid widget, which holds the headers. */ grid?: any; /** - * Used to get a reference to the headers table DOM element. + * Used to get a reference to the headers table DOM element. */ table?: any; } @@ -60164,12 +60164,12 @@ interface PivotGridRenderedEvent { interface PivotGridRenderedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get reference to the igGrid widget, which represents the data. + * Used to get reference to the igGrid widget, which represents the data. */ grid?: any; } @@ -60180,27 +60180,27 @@ interface TupleMemberExpandingEvent { interface TupleMemberExpandingEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to get the name of axis, which holds the member and the tuple. + * Used to get the name of axis, which holds the member and the tuple. */ axisName?: any; /** - * Used to get the index of the tuple in the axis. + * Used to get the index of the tuple in the axis. */ tupleIndex?: any; /** - * Used to get the index of the member in the tuple. + * Used to get the index of the member in the tuple. */ memberIndex?: any; } @@ -60211,27 +60211,27 @@ interface TupleMemberExpandedEvent { interface TupleMemberExpandedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to get the name of axis, which holds the member and the tuple. + * Used to get the name of axis, which holds the member and the tuple. */ axisName?: any; /** - * Used to get the index of the tuple in the axis. + * Used to get the index of the tuple in the axis. */ tupleIndex?: any; /** - * Used to get the index of the member in the tuple. + * Used to get the index of the member in the tuple. */ memberIndex?: any; } @@ -60242,27 +60242,27 @@ interface TupleMemberCollapsingEvent { interface TupleMemberCollapsingEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to get the name of axis, which holds the member and the tuple. + * Used to get the name of axis, which holds the member and the tuple. */ axisName?: any; /** - * Used to get the index of the tuple in the axis. + * Used to get the index of the tuple in the axis. */ tupleIndex?: any; /** - * Used to get the index of the member in the tuple. + * Used to get the index of the member in the tuple. */ memberIndex?: any; } @@ -60273,27 +60273,27 @@ interface TupleMemberCollapsedEvent { interface TupleMemberCollapsedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get a reference to the data source. + * Used to get a reference to the data source. */ dataSource?: any; /** - * Used to get the name of axis, which holds the member and the tuple. + * Used to get the name of axis, which holds the member and the tuple. */ axisName?: any; /** - * Used to get the index of the tuple in the axis. + * Used to get the index of the tuple in the axis. */ tupleIndex?: any; /** - * Used to get the index of the member in the tuple. + * Used to get the index of the member in the tuple. */ memberIndex?: any; } @@ -60304,12 +60304,12 @@ interface SortingEvent { interface SortingEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get an array of the tuple indices and sort directions that will be used. + * Used to get an array of the tuple indices and sort directions that will be used. */ sortDirections?: any; } @@ -60320,17 +60320,17 @@ interface SortedEvent { interface SortedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get an array of the tuple indices and sort directions that were passed to the table view. + * Used to get an array of the tuple indices and sort directions that were passed to the table view. */ sortDirections?: any; /** - * Used to get an array of the tuple indices and sort directions that were actually applied to the table view. + * Used to get an array of the tuple indices and sort directions that were actually applied to the table view. */ appliedSortDirections?: any; } @@ -60341,12 +60341,12 @@ interface HeadersSortingEvent { interface HeadersSortingEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get an array of the level names and sort directions that will be used. + * Used to get an array of the level names and sort directions that will be used. */ levelSortDirections?: any; } @@ -60357,17 +60357,17 @@ interface HeadersSortedEvent { interface HeadersSortedEventUIParam { /** - * Used to get a reference to the pivot grid. + * Used to get a reference to the pivot grid. */ owner?: any; /** - * Used to get an array of the level names and sort directions that were used. + * Used to get an array of the level names and sort directions that were used. */ levelSortDirections?: any; /** - * Used to get an array of the level names and sort directions that were actually applied to the table view. + * Used to get an array of the level names and sort directions that were actually applied to the table view. */ appliedLevelSortDirections?: any; } @@ -60376,7 +60376,7 @@ interface IgPivotGrid { width?: string|number; /** - * This is the total height of the grid. + * This is the total height of the grid. * * Valid values: * "null" Will stretch vertically to fit data, if no other heights are defined @@ -60384,47 +60384,47 @@ interface IgPivotGrid { height?: string|number; /** - * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. */ dataSource?: any; /** - * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. * The provided value must contain an object with settings for one of the data source types - xmlaOptions or flatDataOptions. */ dataSourceOptions?: IgPivotGridDataSourceOptions; /** - * Setting deferUpdate to true will not apply changes to the data source until the updateGrid method is called. + * Setting deferUpdate to true will not apply changes to the data source until the updateGrid method is called. */ deferUpdate?: boolean; /** - * A boolean value indicating whether a parent in the columns is in front of its children. + * A boolean value indicating whether a parent in the columns is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ isParentInFrontForColumns?: boolean; /** - * A boolean value indicating whether a parent in the rows is in front of its children. + * A boolean value indicating whether a parent in the rows is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ isParentInFrontForRows?: boolean; /** - * A boolean value indicating whether the column headers should be arranged for compact header layout i.e. each hierarchy is in a single row. + * A boolean value indicating whether the column headers should be arranged for compact header layout i.e. each hierarchy is in a single row. */ compactColumnHeaders?: boolean; /** - * A boolean value indicating whether the row headers should be arranged for compact header layout i.e. each hierarchy is in a single column. + * A boolean value indicating whether the row headers should be arranged for compact header layout i.e. each hierarchy is in a single column. */ compactRowHeaders?: boolean; /** - * A value indicating whether the layout that row headers should be arranged. standard Each hierarchy in the rows is displayed in a separate column. The child members of a member in the rows are displayed on its right. + * A value indicating whether the layout that row headers should be arranged. standard Each hierarchy in the rows is displayed in a separate column. The child members of a member in the rows are displayed on its right. * superCompact Each hierarchy in the rows is displayed in a separate column. The child members of a member in the rows are displayed on above or below it (Depending on the isParentInFrontForRows setting). * tree All hierarchies in the rows are displayed in a tree-like structure in a single column (The column's width is dependent on the defaultRowHEaderWidth, which can be set to "null" to enable the built-in auto-sizing functionality). * @@ -60437,57 +60437,57 @@ interface IgPivotGrid { rowHeadersLayout?: any; /** - * The indentation for every level column when the compactColumnHeaders is set to true. + * The indentation for every level column when the compactColumnHeaders is set to true. */ compactColumnHeaderIndentation?: number; /** - * The indentation for every level row when the rowHeadersLayout is set to 'superCompact'. + * The indentation for every level row when the rowHeadersLayout is set to 'superCompact'. */ compactRowHeaderIndentation?: number; /** - * Use it when you set rowHeadersLayout to "tree". This property will set a margin between the level's caption and the next level's (underlined text) caption. + * Use it when you set rowHeadersLayout to "tree". This property will set a margin between the level's caption and the next level's (underlined text) caption. */ rowHeaderLinkGroupIndentation?: number; /** - * The indentation for the neighboring hierarchy's level row when the rowHeaderLayout is set to 'tree'. + * The indentation for the neighboring hierarchy's level row when the rowHeaderLayout is set to 'tree'. */ treeRowHeaderIndentation?: number; /** - * Specifies the width of the row headers. + * Specifies the width of the row headers. */ defaultRowHeaderWidth?: number; /** - * Enables sorting of the value cells in columns. + * Enables sorting of the value cells in columns. */ allowSorting?: boolean; /** - * Specifies the default sort direction for the rows. + * Specifies the default sort direction for the rows. */ firstSortDirection?: any; /** - * Enables sorting of the header cells in rows. + * Enables sorting of the header cells in rows. */ allowHeaderRowsSorting?: boolean; /** - * Enables sorting of the header cells in columns. + * Enables sorting of the header cells in columns. */ allowHeaderColumnsSorting?: boolean; /** - * An array of level sort direction items, which predefine the sorted header cells. + * An array of level sort direction items, which predefine the sorted header cells. */ levelSortDirections?: IgPivotGridLevelSortDirection[]; /** - * Specifies the default sort behavior for the levels if no sort behavior is specified in an item from the levelSortDirections option. + * Specifies the default sort behavior for the levels if no sort behavior is specified in an item from the levelSortDirections option. * * Valid values: * "system" Sorts the headers by a specified sort key. @@ -60496,67 +60496,67 @@ interface IgPivotGrid { defaultLevelSortBehavior?: string; /** - * Specifies the default sort direction for the levels if no sort direction is specified in an item from the levelSortDirections option. + * Specifies the default sort direction for the levels if no sort direction is specified in an item from the levelSortDirections option. */ firstLevelSortDirection?: any; /** - * Options specific to the igGrid that will render the pivot grid view. + * Options specific to the igGrid that will render the pivot grid view. */ gridOptions?: IgPivotGridGridOptions; /** - * Settings for the drag and drop functionality of the igPivotGrid. + * Settings for the drag and drop functionality of the igPivotGrid. */ dragAndDropSettings?: IgPivotGridDragAndDropSettings; /** - * Specifies the parent for the drop downs. + * Specifies the parent for the drop downs. */ dropDownParent?: any; /** - * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. */ disableRowsDropArea?: boolean; /** - * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. */ disableColumnsDropArea?: boolean; /** - * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. */ disableMeasuresDropArea?: boolean; /** - * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. */ disableFiltersDropArea?: boolean; /** - * Hide the rows drop area. + * Hide the rows drop area. */ hideRowsDropArea?: boolean; /** - * Hide the columns drop area. + * Hide the columns drop area. */ hideColumnsDropArea?: boolean; /** - * Hide the measures drop area. + * Hide the measures drop area. */ hideMeasuresDropArea?: boolean; /** - * Hide the filters drop area. + * Hide the filters drop area. */ hideFiltersDropArea?: boolean; /** - * A function that will be called to determine if an item can be moved in or dropped on an area of the pivot grid. + * A function that will be called to determine if an item can be moved in or dropped on an area of the pivot grid. * paramType="string" The location where the item will be moved - igPivotGrid, igPivotDataSelector, filters, rows, columns or measures. * paramType="string" The type of the item - Hierarchy, Measure or MeasureList. * paramType="string" The unique name of the item. @@ -60565,7 +60565,7 @@ interface IgPivotGrid { customMoveValidation?: Function; /** - * Fired after the data source has initialized. + * Fired after the data source has initialized. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60575,7 +60575,7 @@ interface IgPivotGrid { dataSourceInitialized?: DataSourceInitializedEvent; /** - * Fired after the data source has updated. + * Fired after the data source has updated. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60585,7 +60585,7 @@ interface IgPivotGrid { dataSourceUpdated?: DataSourceUpdatedEvent; /** - * Event fired after the headers have been rendered. + * Event fired after the headers have been rendered. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.grid to get a reference to the igGrid widget, which holds the headers. @@ -60594,7 +60594,7 @@ interface IgPivotGrid { pivotGridHeadersRendered?: PivotGridHeadersRenderedEvent; /** - * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). + * Event fired after the whole grid widget has been rendered (including headers, footers, etc.). * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.grid to get reference to the igGrid widget, which represents the data. @@ -60602,7 +60602,7 @@ interface IgPivotGrid { pivotGridRendered?: PivotGridRenderedEvent; /** - * Fired before the expand of the tuple member. + * Fired before the expand of the tuple member. * Function takes arguments evt and ui. Return false to cancel the expanding. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60613,7 +60613,7 @@ interface IgPivotGrid { tupleMemberExpanding?: TupleMemberExpandingEvent; /** - * Fired after the expand of the tuple member. + * Fired after the expand of the tuple member. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60624,7 +60624,7 @@ interface IgPivotGrid { tupleMemberExpanded?: TupleMemberExpandedEvent; /** - * Fired before the collapse of the tuple member. + * Fired before the collapse of the tuple member. * Function takes arguments evt and ui. Return false to cancel the collapsing. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60635,7 +60635,7 @@ interface IgPivotGrid { tupleMemberCollapsing?: TupleMemberCollapsingEvent; /** - * Fired after the collapse of the tuple member. + * Fired after the collapse of the tuple member. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.dataSource to get a reference to the data source. @@ -60646,7 +60646,7 @@ interface IgPivotGrid { tupleMemberCollapsed?: TupleMemberCollapsedEvent; /** - * Fired before the sorting of the columns. + * Fired before the sorting of the columns. * Function takes arguments evt and ui. Return false to cancel the sorting. * Use ui.owner to get a reference to the pivot grid. * Use ui.sortDirections to get an array of the tuple indices and sort directions that will be used. @@ -60654,7 +60654,7 @@ interface IgPivotGrid { sorting?: SortingEvent; /** - * Fired after the sorting of the columns. + * Fired after the sorting of the columns. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.sortDirections to get an array of the tuple indices and sort directions that were passed to the table view. @@ -60663,7 +60663,7 @@ interface IgPivotGrid { sorted?: SortedEvent; /** - * Fired before the sorting of the headers. + * Fired before the sorting of the headers. * Function takes arguments evt and ui. Return false to cancel the sorting. * Use ui.owner to get a reference to the pivot grid. * Use ui.levelSortDirections to get an array of the level names and sort directions that will be used. @@ -60671,7 +60671,7 @@ interface IgPivotGrid { headersSorting?: HeadersSortingEvent; /** - * Fired after the sorting of the headers. + * Fired after the sorting of the headers. * Function takes arguments evt and ui. * Use ui.owner to get a reference to the pivot grid. * Use ui.levelSortDirections to get an array of the level names and sort directions that were used. @@ -60680,7 +60680,7 @@ interface IgPivotGrid { headersSorted?: HeadersSortedEvent; /** - * Fired on drag start. Return false to cancel the dragging. + * Fired on drag start. Return false to cancel the dragging. * Use ui.metadatato get a reference to the data. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. @@ -60690,7 +60690,7 @@ interface IgPivotGrid { dragStart?: DragStartEvent; /** - * Fired on drag. Return false to cancel the drag. + * Fired on drag. Return false to cancel the drag. * Use ui.metadatato get a reference to the data. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. @@ -60700,7 +60700,7 @@ interface IgPivotGrid { drag?: DragEvent; /** - * Fired on drag stop. + * Fired on drag stop. * Use ui.helper to get a reference to the helper. * Use ui.offset to get a reference to the offset. * Use ui.originalPosition to get a reference to the original position of the draggable element. @@ -60709,7 +60709,7 @@ interface IgPivotGrid { dragStop?: DragStopEvent; /** - * Fired before a metadata item drop. Return false to cancel the drop. + * Fired before a metadata item drop. Return false to cancel the drop. * Use ui.targetElement for a reference to the drop target. * Use ui.draggedElement for a reference to the metadata item element. * Use ui.metadatato get a reference to the data. @@ -60721,7 +60721,7 @@ interface IgPivotGrid { metadataDropping?: MetadataDroppingEvent; /** - * Fired after a metadata item drop. + * Fired after a metadata item drop. * Use ui.targetElement for a reference to the drop target. * Use ui.draggedElement for a reference to the dragged element. * Use ui.metadatato get a reference to the data. @@ -60733,33 +60733,33 @@ interface IgPivotGrid { metadataDropped?: MetadataDroppedEvent; /** - * Fired before a metadata item is removed when the user clicks the close icon. Return false to cancel the removing. + * Fired before a metadata item is removed when the user clicks the close icon. Return false to cancel the removing. * Use ui.targetElement for a reference to the dragged element. * Use ui.metadatato get a reference to the data. */ metadataRemoving?: MetadataRemovingEvent; /** - * Fired after a metadata item is removed when the user clicks the close icon. + * Fired after a metadata item is removed when the user clicks the close icon. * Use ui.metadatato get a reference to the data. */ metadataRemoved?: MetadataRemovedEvent; /** - * Fired before the filter members drop down opens. Return false to cancel the opening. + * Fired before the filter members drop down opens. Return false to cancel the opening. * Use ui.hierarchy for a reference to the hierarchy. */ filterDropDownOpening?: FilterDropDownOpeningEvent; /** - * Fired after the filter members drop down opens. + * Fired after the filter members drop down opens. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.dropDownElement for a reference to the drop down. */ filterDropDownOpened?: FilterDropDownOpenedEvent; /** - * Fired after the filter members are loaded. + * Fired after the filter members are loaded. * Use ui.parent to get the parent node or the igTree instance in the initial load. * Use ui.rootFilterMembers for a collection with the root filter members . * Use ui.filterMembers for a collection with the newly loaded filter members. @@ -60767,7 +60767,7 @@ interface IgPivotGrid { filterMembersLoaded?: FilterMembersLoadedEvent; /** - * Fired after the OK button in the filter members drop down is clicked. Return false to cancel the applying of the filters. + * Fired after the OK button in the filter members drop down is clicked. Return false to cancel the applying of the filters. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.filterMembers for a collection with the selected filter members. If all filter members are selected the collection will be empty. * Use ui.dropDownElement for a reference to the drop down. @@ -60775,36 +60775,36 @@ interface IgPivotGrid { filterDropDownOk?: FilterDropDownOkEvent; /** - * Fired before the filter members drop down closes. Return false to cancel the closing. + * Fired before the filter members drop down closes. Return false to cancel the closing. * Use ui.hierarchy for a reference to the hierarchy. * Use ui.dropDownElement for a reference to the drop down. */ filterDropDownClosing?: FilterDropDownClosingEvent; /** - * Fired after the filter members drop down closes. + * Fired after the filter members drop down closes. * Use ui.hierarchy for a reference to the hierarchy. */ filterDropDownClosed?: FilterDropDownClosedEvent; /** - * Option for igPivotGrid + * Option for igPivotGrid */ [optionName: string]: any; } interface IgPivotGridMethods { /** - * Returns the igGrid instance used to render the OLAP data. + * Returns the igGrid instance used to render the OLAP data. */ grid(): Object; /** - * Triggers an update on the data source and the igPivotGrid. + * Triggers an update on the data source and the igPivotGrid. */ updateGrid(): void; /** - * Expands a member from the data source and returns true if the expand succeeds. If the data source has a pending update, the method will return false. Note that igPivotGrid to will display the expanded result after the data source is updated. + * Expands a member from the data source and returns true if the expand succeeds. If the data source has a pending update, the method will return false. Note that igPivotGrid to will display the expanded result after the data source is updated. * * @param tupleLocation The name of the parent axis - 'columnAxis' or 'rowAxis'. * @param tupleIndex The index of the containing tuple. This index should correspond to the position of the tuple in the original unsorted result of the data source. @@ -60814,7 +60814,7 @@ interface IgPivotGridMethods { expandTupleMember(tupleLocation: string, tupleIndex: number, memberIndex: number, shouldUpdate?: boolean): boolean; /** - * Collapses a member from the data source and returns true if the collapse succeeds. If the data source has a pending update, the method will return false. Note that igPivotGrid to will display the expanded result after the data source is updated. + * Collapses a member from the data source and returns true if the collapse succeeds. If the data source has a pending update, the method will return false. Note that igPivotGrid to will display the expanded result after the data source is updated. * * @param tupleLocation The name of the parent axis - 'columnAxis' or 'rowAxis'. * @param tupleIndex The index of the containing tuple. This index should correspond to the position of the tuple in the original unsorted result of the data source. @@ -60824,7 +60824,7 @@ interface IgPivotGridMethods { collapseTupleMember(tupleLocation: string, tupleIndex: number, memberIndex: number, shouldUpdate?: boolean): boolean; /** - * Returns an array with the applied sort directions on the igPivotGrid's columns. The returned array contains objects with the following properties: + * Returns an array with the applied sort directions on the igPivotGrid's columns. The returned array contains objects with the following properties: * memberNames: The names of the members in the tuple. * tupleIndex: The index of the tuple on the column axis in the original unsorted result. * sortDirection: The direction of the sort - ascending or descending. @@ -60832,14 +60832,14 @@ interface IgPivotGridMethods { appliedColumnSortDirections(): any[]; /** - * Returns an array with the applied level sort direction items, which were used for the sorting of the header cells. The returned array contains objects with the following properties: + * Returns an array with the applied level sort direction items, which were used for the sorting of the header cells. The returned array contains objects with the following properties: * levelUniqueName: Specifies the unique name of the level, which was sorted. * sortDirection: The direction of the header sort - ascending or descending. */ appliedLevelSortDirections(): any[]; /** - * Destroy is part of the jQuery UI widget API and does the following: + * Destroy is part of the jQuery UI widget API and does the following: * 1. Remove custom CSS classes that were added. * 2. Unwrap any wrapping elements such as scrolling divs and other containers. * 3. Unbind all events that were bound. @@ -61790,389 +61790,389 @@ interface JQuery { } interface IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions { /** - * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. + * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest * and will prompt the user for credentials. */ withCredentials?: boolean; /** - * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax’s options object. + * A callback to be invoked right before the request is send to the server. Extends beforeSend callback of jQuery.ajax’s options object. */ beforeSend?: Function; /** - * Option for IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions + * Option for IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings { /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ nonEmptyOnRows?: boolean; /** - * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true + * Optional="true" a value indicating whether a NON EMPTY clause is present on COLUMNS axis. Default value is true */ nonEmptyOnColumns?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on ROWS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnRows?: boolean; /** - * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true + * Optional="true" a value indicating whether a members' set expressions on COLUMNS axis should be wrapped with AddCalculatedMembers MDX method. Default value is true */ addCalculatedMembersOnColumns?: boolean; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on ROWS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnRows?: any[]; /** - * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES + * Optional="true" a string array with the names of intrinsic non-context sensitive member properties applied on COLUMNS axis. By defult CHILDREN_CARDINALITY and PARENT_UNIQUE_NAME properties are always added to DIMENSION PROPERTIES */ dimensionPropertiesOnColumns?: any[]; /** - * Option for IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings + * Option for IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsXmlaOptions { /** - * Optional="false" The URL of the XMLA server. + * Optional="false" The URL of the XMLA server. */ serverUrl?: string; /** - * The catalog name. + * The catalog name. */ catalog?: string; /** - * The name of the cube in the data source. + * The name of the cube in the data source. */ cube?: string; /** - * The name of the measure group in the data source. + * The name of the measure group in the data source. */ measureGroup?: string; /** - * An object containing information about how the request to the XMLA server should be processed. + * An object containing information about how the request to the XMLA server should be processed. */ requestOptions?: IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions; /** - * Enables/disables caching of the XMLA result object. + * Enables/disables caching of the XMLA result object. */ enableResultCache?: boolean; /** - * Additional properties sent with every discover request. + * Additional properties sent with every discover request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ discoverProperties?: any; /** - * Additional properties sent with every execute request. + * Additional properties sent with every execute request. * The object is treated as a key/value store where each property name is used as the key and the property value as the value. */ executeProperties?: any; /** - * Optional="true" a javascript object containing information about how the request to the xmla server should be processed + * Optional="true" a javascript object containing information about how the request to the xmla server should be processed */ mdxSettings?: IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings; /** - * Option for IgPivotViewDataSourceOptionsXmlaOptions + * Option for IgPivotViewDataSourceOptionsXmlaOptions */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { /** - * Optional="false" A unique name for the measure. + * Optional="false" A unique name for the measure. */ name?: string; /** - * A caption for the measure. + * A caption for the measure. */ caption?: string; /** - * Optional="false" An aggregator function called when each cell is evaluated. + * Optional="false" An aggregator function called when each cell is evaluated. * Returns a value for the cell. If the returned value is null, no cell will be created in for the data source result. */ aggregator?: Function; /** - * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). + * The path used when displaying the measure in the user interface. Nested folders are indicated by a backslash (\). */ displayFolder?: string; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { /** - * A unique name for the measures dimension. + * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: * [].[] */ name?: string; /** - * A caption for the measures dimension. + * A caption for the measures dimension. * The default value is "Measures". */ caption?: string; /** - * An array of measure metadata objects. + * An array of measure metadata objects. */ measures?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure[]; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { /** - * Optional="false" A name for the level. + * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: * {}.[] */ name?: string; /** - * A caption for the level. + * A caption for the level. */ caption?: string; /** - * A function called for each item of the data source array when level members are created. + * A function called for each item of the data source array when level members are created. * Based on the item parameter the function should return a value that will form the $.ig.Member’s name and caption. */ memberProvider?: Function; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { /** - * Optional="false" A name for the hierarchy. + * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: * [].[] */ name?: string; /** - * A caption for the hierarchy. + * A caption for the hierarchy. */ caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. + * The path to be used when displaying the hierarchy in the user interface. * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; /** - * An array of level metadata objects. + * An array of level metadata objects. */ levels?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel[]; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension { /** - * Optional="false" A unique name for the dimension. + * Optional="false" A unique name for the dimension. */ name?: string; /** - * A caption for the dimension. + * A caption for the dimension. */ caption?: string; /** - * An array of hierarchy metadata objects. + * An array of hierarchy metadata objects. */ hierarchies?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie[]; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube { /** - * Optional="false" A unique name for the cube. + * Optional="false" A unique name for the cube. */ name?: string; /** - * A caption for the cube. + * A caption for the cube. */ caption?: string; /** - * An object providing information about the measures' root node. + * An object providing information about the measures' root node. */ measuresDimension?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension; /** - * An array of dimension metadata objects. + * An array of dimension metadata objects. */ dimensions?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension[]; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadata { /** - * Optional="false" Metadata used for the creation of the cube. + * Optional="false" Metadata used for the creation of the cube. */ cube?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadata + * Option for IgPivotViewDataSourceOptionsFlatDataOptionsMetadata */ [optionName: string]: any; } interface IgPivotViewDataSourceOptionsFlatDataOptions { /** - * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. + * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ dataSource?: any; /** - * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. + * Specifies a remote URL accepted by $.ig.DataSource in order to request data from it. */ dataSourceUrl?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. */ dataSourceType?: string; /** - * See $.ig.DataSource. + * See $.ig.DataSource. * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; /** - * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. + * String Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property. * null Option is ignored. */ responseDataType?: string; /** - * Optional="false" An object containing processing instructions for the $.ig.DataSource data. + * Optional="false" An object containing processing instructions for the $.ig.DataSource data. */ metadata?: IgPivotViewDataSourceOptionsFlatDataOptionsMetadata; /** - * Option for IgPivotViewDataSourceOptionsFlatDataOptions + * Option for IgPivotViewDataSourceOptionsFlatDataOptions */ [optionName: string]: any; } interface IgPivotViewDataSourceOptions { /** - * Settings for creating an instance of $.ig.OlapXmlaDataSource. + * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ xmlaOptions?: IgPivotViewDataSourceOptionsXmlaOptions; /** - * Settings for creating an instance of $.ig.OlapFlatDataSource. + * Settings for creating an instance of $.ig.OlapFlatDataSource. */ flatDataOptions?: IgPivotViewDataSourceOptionsFlatDataOptions; /** - * A list of measure names separated by comma (,). These will be the measures of the data source. + * A list of measure names separated by comma (,). These will be the measures of the data source. */ measures?: string; /** - * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. + * A list of hierarchy names separated by comma (,). These will be hierarchies in the filters of the data source. */ filters?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the rows of the data source. */ rows?: string; /** - * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. + * A list of hierarchy names separated by comma (,). These will be the hierarchies in the columns of the data source. */ columns?: string; /** - * Option for IgPivotViewDataSourceOptions + * Option for IgPivotViewDataSourceOptions */ [optionName: string]: any; } interface IgPivotViewPivotGridOptionsLevelSortDirection { /** - * Specifies the unique name of the level, which will be sorted. + * Specifies the unique name of the level, which will be sorted. */ levelUniqueName?: string; /** - * optional="true" Specifies the sort direction. If no direction is specified,the level is going to be sorted in the direction specified by the firstLevelSortDirection option. + * optional="true" Specifies the sort direction. If no direction is specified,the level is going to be sorted in the direction specified by the firstLevelSortDirection option. * */ sortDirection?: any; /** - * Option for IgPivotViewPivotGridOptionsLevelSortDirection + * Option for IgPivotViewPivotGridOptionsLevelSortDirection */ [optionName: string]: any; } interface IgPivotViewPivotGridOptionsGridOptionsFeatures { /** - * Option for IgPivotViewPivotGridOptionsGridOptionsFeatures + * Option for IgPivotViewPivotGridOptionsGridOptionsFeatures */ [optionName: string]: any; } interface IgPivotViewPivotGridOptionsGridOptions { /** - * Default column width that will be set for all columns. + * Default column width that will be set for all columns. * * Valid values: * "string" The default column width can be set in pixels (px). @@ -62181,191 +62181,191 @@ interface IgPivotViewPivotGridOptionsGridOptions { defaultColumnWidth?: string|number; /** - * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. + * Headers will be fixed if this option is set to true, and only the grid data will be scrollable. */ fixedHeaders?: boolean; /** - * Caption text that will be shown above the pivot grid header. + * Caption text that will be shown above the pivot grid header. */ caption?: string; /** - * A list of grid features definitions. The supported features are Resizing and Tooltips. Each feature goes with its separate options that are documented for the feature accordingly. + * A list of grid features definitions. The supported features are Resizing and Tooltips. Each feature goes with its separate options that are documented for the feature accordingly. */ features?: IgPivotViewPivotGridOptionsGridOptionsFeatures; /** - * Initial tabIndex attribute that will be set on the container element. + * Initial tabIndex attribute that will be set on the container element. */ tabIndex?: number; /** - * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). Note that if a custom jQuery template is set, this has no effect and CSS for the row should be adjusted manually in the template contents. + * Enables/disables rendering of alternating row styles (odd and even rows receive different styling). Note that if a custom jQuery template is set, this has no effect and CSS for the row should be adjusted manually in the template contents. */ alternateRowStyles?: boolean; /** - * Enables/disables rendering of ui-state-hover classes when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. + * Enables/disables rendering of ui-state-hover classes when the mouse is over a record. This can be useful in templating scenarios, for example, where we don't want to apply hover styling to templated content. */ enableHoverStyles?: boolean; /** - * Option for IgPivotViewPivotGridOptionsGridOptions + * Option for IgPivotViewPivotGridOptionsGridOptions */ [optionName: string]: any; } interface IgPivotViewPivotGridOptionsDragAndDropSettings { /** - * Which element the draggable helper should be appended to while dragging. + * Which element the draggable helper should be appended to while dragging. */ appendTo?: any; /** - * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. + * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. * */ containment?: boolean|string|Array; /** - * Specifies z-index that would be set for the drag helper. + * Specifies z-index that would be set for the drag helper. */ zIndex?: number; /** - * Option for IgPivotViewPivotGridOptionsDragAndDropSettings + * Option for IgPivotViewPivotGridOptionsDragAndDropSettings */ [optionName: string]: any; } interface IgPivotViewPivotGridOptions { /** - * A boolean value indicating whether a parent in the columns is in front of its children. + * A boolean value indicating whether a parent in the columns is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ isParentInFrontForColumns?: boolean; /** - * A boolean value indicating whether a parent in the rows is in front of its children. + * A boolean value indicating whether a parent in the rows is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ isParentInFrontForRows?: boolean; /** - * A boolean value indicating wheter the column headers should be arranged for compact header layout – each hieararchy is in a single row. + * A boolean value indicating wheter the column headers should be arranged for compact header layout – each hieararchy is in a single row. */ compactColumnHeaders?: boolean; /** - * A value indicating wheter the layout that row headers should be arranged. For compact header layout – each hieararchy is in a single column. + * A value indicating wheter the layout that row headers should be arranged. For compact header layout – each hieararchy is in a single column. */ rowHeadersLayout?: any; /** - * The indentation for every level column when the compactColumnHeaders is set to true. + * The indentation for every level column when the compactColumnHeaders is set to true. */ compactColumnHeaderIndentation?: number; /** - * The indentation for every level row when the rowHeadersLayout is set to 'compact'. + * The indentation for every level row when the rowHeadersLayout is set to 'compact'. */ compactRowHeaderIndentation?: number; /** - * Typle="number" Specifies the width of the row headers. + * Typle="number" Specifies the width of the row headers. */ defaultRowHeaderWidth?: number; /** - * Enables sorting of the value cells in columns. + * Enables sorting of the value cells in columns. */ allowSorting?: boolean; /** - * Spefies the default sort direction for the rows. + * Spefies the default sort direction for the rows. */ firstSortDirection?: any; /** - * Enables sorting of the header cells in rows. + * Enables sorting of the header cells in rows. */ allowHeaderRowsSorting?: boolean; /** - * Enables sorting of the header cells in columns. + * Enables sorting of the header cells in columns. */ allowHeaderColumnsSorting?: boolean; /** - * An array of level sort direction items, which predefine the sorted header cells. + * An array of level sort direction items, which predefine the sorted header cells. */ levelSortDirections?: IgPivotViewPivotGridOptionsLevelSortDirection[]; /** - * Spefies the default sort direction for the levels if no sort direction is specified in an item from the levelSortDirections option. + * Spefies the default sort direction for the levels if no sort direction is specified in an item from the levelSortDirections option. */ firstLevelSortDirection?: any; /** - * Options specific to the igGrid that will render the pivot grid view. + * Options specific to the igGrid that will render the pivot grid view. */ gridOptions?: IgPivotViewPivotGridOptionsGridOptions; /** - * Settings for the drag and drop functionality of the igPivotDataSelector. + * Settings for the drag and drop functionality of the igPivotDataSelector. */ dragAndDropSettings?: IgPivotViewPivotGridOptionsDragAndDropSettings; /** - * Specifies the parent for the drop downs. + * Specifies the parent for the drop downs. */ dropDownParent?: any; /** - * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the rows drop area and the ability to use filtering and remove items from it. */ disableRowsDropArea?: boolean; /** - * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the columns drop area and the ability to use filtering and remove items from it. */ disableColumnsDropArea?: boolean; /** - * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the measures drop area and the ability to use filtering and remove items from it. */ disableMeasuresDropArea?: boolean; /** - * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. + * Disable the drag and drop for the filters drop area and the ability to use filtering and remove items from it. */ disableFiltersDropArea?: boolean; /** - * Hide the rows drop area. + * Hide the rows drop area. */ hideRowsDropArea?: boolean; /** - * Hide the columns drop area. + * Hide the columns drop area. */ hideColumnsDropArea?: boolean; /** - * Hide the measures drop area. + * Hide the measures drop area. */ hideMeasuresDropArea?: boolean; /** - * Hide the filters drop area. + * Hide the filters drop area. */ hideFiltersDropArea?: boolean; /** - * A function that will be called to determine if an item can be moved in or dropped on an area of the pivot grid. + * A function that will be called to determine if an item can be moved in or dropped on an area of the pivot grid. * paramType="string" The location where the item will be moved - igPivotGrid, igPivotDataSelector, filters, rows, columns or measures. * paramType="string" The type of the item - Hierarchy, Measure or MeasureList. * paramType="string" The unique name of the item. @@ -62374,47 +62374,47 @@ interface IgPivotViewPivotGridOptions { customMoveValidation?: Function; /** - * Option for IgPivotViewPivotGridOptions + * Option for IgPivotViewPivotGridOptions */ [optionName: string]: any; } interface IgPivotViewDataSelectorOptionsDragAndDropSettings { /** - * Which element the draggable helper should be appended to while dragging. + * Which element the draggable helper should be appended to while dragging. */ appendTo?: any; /** - * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. + * Specifies the containment for the drag helper. The area inside of which the helper is contained would be scrollable while dragging. * */ containment?: boolean|string|Array; /** - * Specifies z-index that would be set for the drag helper. + * Specifies z-index that would be set for the drag helper. */ zIndex?: number; /** - * Option for IgPivotViewDataSelectorOptionsDragAndDropSettings + * Option for IgPivotViewDataSelectorOptionsDragAndDropSettings */ [optionName: string]: any; } interface IgPivotViewDataSelectorOptions { /** - * Settings for the drag and drop functionality of the igPivotDataSelector. + * Settings for the drag and drop functionality of the igPivotDataSelector. */ dragAndDropSettings?: IgPivotViewDataSelectorOptionsDragAndDropSettings; /** - * Specifies the parent for the drop downs. + * Specifies the parent for the drop downs. */ dropDownParent?: any; /** - * A function that will be called to determine if an item can be moved in or dropped on an area of the data selector. + * A function that will be called to determine if an item can be moved in or dropped on an area of the data selector. * paramType="string" The location where the item will be moved - igPivotGrid, igPivotDataSelector, filters, rows, columns or measures. * paramType="string" The type of the item - Hierarchy, Measure or MeasureList. * paramType="string" The unique name of the item. @@ -62423,29 +62423,29 @@ interface IgPivotViewDataSelectorOptions { customMoveValidation?: Function; /** - * Option for IgPivotViewDataSelectorOptions + * Option for IgPivotViewDataSelectorOptions */ [optionName: string]: any; } interface IgPivotViewPivotGridPanel { /** - * Determines if the panel containing the igPivotGrid will be resizable. + * Determines if the panel containing the igPivotGrid will be resizable. */ resizable?: boolean; /** - * Determines if the panel containing the igPivotGrid will be collapsible. + * Determines if the panel containing the igPivotGrid will be collapsible. */ collapsible?: boolean; /** - * Determines if the panel containing the igPivotGrid will initially collapsed. + * Determines if the panel containing the igPivotGrid will initially collapsed. */ collapsed?: boolean; /** - * Determines the size of the igPivotGrid panel. + * Determines the size of the igPivotGrid panel. * * Valid values: * "string" The panel size can be set in pixels (px). @@ -62455,34 +62455,34 @@ interface IgPivotViewPivotGridPanel { size?: string|number; /** - * Option for IgPivotViewPivotGridPanel + * Option for IgPivotViewPivotGridPanel */ [optionName: string]: any; } interface IgPivotViewDataSelectorPanel { /** - * Determines the position of the data selector panel inside the igPivotView widget. + * Determines the position of the data selector panel inside the igPivotView widget. */ location?: any; /** - * Determines if the panel containing the igPivotDataSelector will be resizable. + * Determines if the panel containing the igPivotDataSelector will be resizable. */ resizable?: boolean; /** - * Determines if the panel containing the igPivotDataSelector will be collapsible. + * Determines if the panel containing the igPivotDataSelector will be collapsible. */ collapsible?: boolean; /** - * Determines if the panel containing the igPivotDataSelector will initially collapsed. + * Determines if the panel containing the igPivotDataSelector will initially collapsed. */ collapsed?: boolean; /** - * Determines the size of the igPivotDataSelector panel. The recommended value is 250px. + * Determines the size of the igPivotDataSelector panel. The recommended value is 250px. * * Valid values: * "string" The panel size can be set in pixels (px). @@ -62492,7 +62492,7 @@ interface IgPivotViewDataSelectorPanel { size?: string|number; /** - * Option for IgPivotViewDataSelectorPanel + * Option for IgPivotViewDataSelectorPanel */ [optionName: string]: any; } @@ -62502,62 +62502,62 @@ interface IgPivotView { height?: string|number; /** - * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. */ dataSource?: any; /** - * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. + * An object that will be used to create an instance of $.ig.OlapXmlaDataSource or $.ig.OlapFlatDataSource. * The provided value must contain an object with settings for one of the data source types - xmlaOptions or flatDataOptions. */ dataSourceOptions?: IgPivotViewDataSourceOptions; /** - * Configuration settings that will be assigned to the igPivotGrid widget. + * Configuration settings that will be assigned to the igPivotGrid widget. */ pivotGridOptions?: IgPivotViewPivotGridOptions; /** - * Configuration settings that will be assigned to the igPivotDataSelector widget. + * Configuration settings that will be assigned to the igPivotDataSelector widget. */ dataSelectorOptions?: IgPivotViewDataSelectorOptions; /** - * Configuration settings for the panel containing the igPivotGrid. + * Configuration settings for the panel containing the igPivotGrid. */ pivotGridPanel?: IgPivotViewPivotGridPanel; /** - * Configuration settings for the panel containing the igPivotDataSelector. + * Configuration settings for the panel containing the igPivotDataSelector. */ dataSelectorPanel?: IgPivotViewDataSelectorPanel; /** - * Option for igPivotView + * Option for igPivotView */ [optionName: string]: any; } interface IgPivotViewMethods { /** - * Returns the igPivotGrid instance of the pivot view. + * Returns the igPivotGrid instance of the pivot view. */ pivotGrid(): Object; /** - * Returns the igPivotDataSelector instance of the pivot view. + * Returns the igPivotDataSelector instance of the pivot view. */ dataSelector(): Object; /** - * Returns the igSplitter instance used to separate the pivot grid and the data selector. + * Returns the igSplitter instance used to separate the pivot grid and the data selector. */ splitter(): Object; /** - * Destroy is part of the jQuery UI widget API and does the following: - * 1. Remove custom CSS classes that were added. - * 2. Unwrap any wrapping elements such as scrolling divs and other containers. - * 3. Unbind all events that were bound. + * Destroy is part of the jQuery UI widget API and does the following: + * 1. Remove custom CSS classes that were added. + * 2. Unwrap any wrapping elements such as scrolling divs and other containers. + * 3. Unbind all events that were bound. */ destroy(): void; } @@ -62668,12 +62668,12 @@ interface JQuery { } interface IgPopover { /** - * Controls whether the popover will close on blur or not + * Controls whether the popover will close on blur or not */ closeOnBlur?: boolean; /** - * controls the direction in which the control shows relative to the target element + * controls the direction in which the control shows relative to the target element * * Valid values: * "auto" lets the control show on the side where enough space is available with the following priority top > bottom > right > left @@ -62685,7 +62685,7 @@ interface IgPopover { direction?: string; /** - * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area + * controls the position of the popover according to the target element in case the popover is larger than the target on the side we want to position, if the popover is smaller it should always be in the middle of the visible area * * Valid values: * "auto" lets the control choose a position depending on available space with the following priority balanced > end > start @@ -62696,37 +62696,37 @@ interface IgPopover { position?: string; /** - * defines width for the popover. leave null for auto. + * defines width for the popover. leave null for auto. */ width?: number|string; /** - * defines height for the popover. leave null for auto + * defines height for the popover. leave null for auto */ height?: number|string; /** - * defines width the popover won't go under the value even if no specific one is set. + * defines width the popover won't go under the value even if no specific one is set. */ minWidth?: number|string; /** - * defines width the popover won't exceed even if no specific one is set. + * defines width the popover won't exceed even if no specific one is set. */ maxWidth?: number|string; /** - * defines height the popover won't exceed even if no specific one is set. + * defines height the popover won't exceed even if no specific one is set. */ maxHeight?: number|string; /** - * Sets the time popover fades in and out when showing/hiding + * Sets the time popover fades in and out when showing/hiding */ animationDuration?: number; /** - * sets the content for the popover container. If left null the content will be get from the target. + * sets the content for the popover container. If left null the content will be get from the target. * * Valid values: * "string" String content of the popover container @@ -62735,17 +62735,17 @@ interface IgPopover { contentTemplate?: string|Function; /** - * Selectors indicating which items should show popovers. The predefined value is [title]. Customize if you're using something other then the title attribute for the popover content, or if you need a different selector for event delegation. When changing this option, you likely need to also change the contentTemplate option + * Selectors indicating which items should show popovers. The predefined value is [title]. Customize if you're using something other then the title attribute for the popover content, or if you need a different selector for event delegation. When changing this option, you likely need to also change the contentTemplate option */ selectors?: string; /** - * Sets the content for the popover header + * Sets the content for the popover header */ headerTemplate?: IgPopoverHeaderTemplate; /** - * sets the event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" + * sets the event on which the popover will be shown. Predefined values are "mouseenter", "click" and "focus" * * Valid values: * "mouseenter" the popover is shown on mouse enter in the target element @@ -62755,12 +62755,12 @@ interface IgPopover { showOn?: string; /** - * Sets the containment for the popover. Accepts a jQuery object + * Sets the containment for the popover. Accepts a jQuery object */ containment?: any; /** - * Controls where the popover DOM should be attached to. + * Controls where the popover DOM should be attached to. * * * Valid values: @@ -62770,7 +62770,7 @@ interface IgPopover { appendTo?: string|Object; /** - * Event fired before popover is shown. + * Event fired before popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will show for. * Use ui.content to get or set the content to be shown as a string. @@ -62780,7 +62780,7 @@ interface IgPopover { showing?: ShowingEvent; /** - * Event fired after popover is shown. + * Event fired after popover is shown. * Function takes arguments evt and ui. * Use ui.element to get the element the popover showed for. * Use ui.content to get the content that was shown as a string. @@ -62790,7 +62790,7 @@ interface IgPopover { shown?: ShownEvent; /** - * Event fired before popover is hidden. + * Event fired before popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover will hide for. * Use ui.content to get the current content displayed in the popover as a string. @@ -62800,7 +62800,7 @@ interface IgPopover { hiding?: HidingEvent; /** - * Event fired after popover is hidden. + * Event fired after popover is hidden. * Function takes arguments evt and ui. * Use ui.element to get the element the popover is hidden for. * Use ui.content to get the content displayed in the popover as a string. @@ -62810,28 +62810,28 @@ interface IgPopover { hidden?: HiddenEvent; /** - * Option for igPopover + * Option for igPopover */ [optionName: string]: any; } interface IgPopoverMethods { /** - * Destroys the popover widget. + * Destroys the popover widget. */ destroy(): void; /** - * Returns the ID of the element the popover is attached to + * Returns the ID of the element the popover is attached to */ id(): string; /** - * Returns the container for the popover contents + * Returns the container for the popover contents */ container(): Object; /** - * Shows the popover for the specified target + * Shows the popover for the specified target * * @param trg The element to show popover for. * @param content The string to set for the popover to show. @@ -62839,34 +62839,34 @@ interface IgPopoverMethods { show(trg?: Element, content?: string): void; /** - * Hides the popover for the specified target + * Hides the popover for the specified target */ hide(): void; /** - * Gets the currently set content for the popover container + * Gets the currently set content for the popover container */ getContent(): string; /** - * Sets the content for the popover container + * Sets the content for the popover container * * @param newCnt The popover content to set. */ setContent(newCnt: string): void; /** - * Gets the popover current target + * Gets the popover current target */ target(): Object; /** - * Gets the current coordinates of the popover + * Gets the current coordinates of the popover */ getCoordinates(): Object; /** - * Sets the popover to specific coordinates. + * Sets the popover to specific coordinates. * * @param pos The popover coordinates in pixels. */ @@ -63165,136 +63165,136 @@ interface JQuery { } interface IgRadialGaugeRange { /** - * Gets or sets the name of the range. + * Gets or sets the name of the range. */ name?: string; /** - * Gets or sets the starting value of the range. + * Gets or sets the starting value of the range. */ startValue?: number; /** - * Gets or sets the ending value of the range. + * Gets or sets the ending value of the range. */ endValue?: number; /** - * Gets or sets the starting value of the outer extent of the range. + * Gets or sets the starting value of the outer extent of the range. */ outerStartExtent?: number; /** - * Gets or sets the ending value of the outer extent of the range. + * Gets or sets the ending value of the outer extent of the range. */ outerEndExtent?: number; /** - * Gets or sets the starting value of the inner extent of the range. + * Gets or sets the starting value of the inner extent of the range. */ innerStartExtent?: number; /** - * Gets or sets the ending value of the inner extent of the range. + * Gets or sets the ending value of the inner extent of the range. */ innerEndExtent?: number; /** - * Gets or sets the brush for the entire range. + * Gets or sets the brush for the entire range. */ brush?: string; /** - * Gets or sets the brush for the outline of the range. + * Gets or sets the brush for the outline of the range. */ outline?: string; /** - * Gets or sets the thickness of the range outline. + * Gets or sets the thickness of the range outline. */ strokeThickness?: number; /** - * Gets or sets the flag used to determine if the range should be removed. If set to true, the range (if existing) is removed. + * Gets or sets the flag used to determine if the range should be removed. If set to true, the range (if existing) is removed. */ remove?: boolean; /** - * Option for IgRadialGaugeRange + * Option for IgRadialGaugeRange */ [optionName: string]: any; } interface IgRadialGauge { /** - * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Gets or sets the scale ranges to render on the linear gauge. + * Gets or sets the scale ranges to render on the linear gauge. */ ranges?: IgRadialGaugeRange[]; /** - * Gets or sets a collection of brushes to be used as the palette for gauge ranges. + * Gets or sets a collection of brushes to be used as the palette for gauge ranges. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeBrushes?: any; /** - * Gets or sets a collection of brushes to be used as the palette for gauge outlines. + * Gets or sets a collection of brushes to be used as the palette for gauge outlines. * The value provided should be an array of css color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection. */ rangeOutlines?: any; /** - * Gets or sets the minimum value of the scale. + * Gets or sets the minimum value of the scale. */ minimumValue?: number; /** - * Gets or sets the maximum value of the scale. + * Gets or sets the maximum value of the scale. */ maximumValue?: number; /** - * Gets or sets the interval to use for the scale. + * Gets or sets the interval to use for the scale. */ interval?: number; /** - * Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1. + * Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1. */ centerX?: number; /** - * Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1. + * Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1. */ centerY?: number; /** - * Gets or sets the value at which to point the needle of the gauge. + * Gets or sets the value at which to point the needle of the gauge. */ value?: number; /** - * Gets or sets the start angle for the scale in degrees. + * Gets or sets the start angle for the scale in degrees. */ scaleStartAngle?: number; /** - * Gets or sets the end angle for the scale in degrees. + * Gets or sets the end angle for the scale in degrees. */ scaleEndAngle?: number; /** - * Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. + * Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. * * Valid values: * "counterclockwise" @@ -63303,39 +63303,39 @@ interface IgRadialGauge { scaleSweepDirection?: string; /** - * Gets or sets the number of milliseconds over which changes to the gauge should be animated. + * Gets or sets the number of milliseconds over which changes to the gauge should be animated. */ transitionDuration?: number; /** - * Gets or sets the easing function used to morph the current series. + * Gets or sets the easing function used to morph the current series. */ transitionEasingFunction?: any; /** - * Gets or sets the brush to use when rendering the fill of the needle. + * Gets or sets the brush to use when rendering the fill of the needle. */ needleBrush?: string; /** - * Gets or sets the brush to use when rendering the outline of the needle. + * Gets or sets the brush to use when rendering the outline of the needle. */ needleOutline?: string; /** - * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleStartExtent?: number; /** - * Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. + * Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleEndExtent?: number; /** - * Gets or sets the shape to use when rendering the needle from a number of options. + * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: * "none" @@ -63351,54 +63351,54 @@ interface IgRadialGauge { needleShape?: string; /** - * Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. + * Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleStartWidthRatio?: number; /** - * Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. + * Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleEndWidthRatio?: number; /** - * Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleBaseFeatureWidthRatio?: number; /** - * Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleBaseFeatureExtent?: number; /** - * Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needlePointFeatureWidthRatio?: number; /** - * Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. + * Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needlePointFeatureExtent?: number; /** - * Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. + * Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needlePivotWidthRatio?: number; /** - * Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section. + * Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section. */ needlePivotInnerWidthRatio?: number; /** - * Gets or sets the shape to use for the needle cap. + * Gets or sets the shape to use for the needle cap. * * Valid values: * "none" @@ -63412,139 +63412,139 @@ interface IgRadialGauge { needlePivotShape?: string; /** - * Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. + * Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ scaleStartExtent?: number; /** - * Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes. + * Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes. */ needlePivotBrush?: string; /** - * Gets or sets the brush to use for the outlines of the needle cap. + * Gets or sets the brush to use for the outlines of the needle cap. */ needlePivotOutline?: string; /** - * Gets or sets the stroke thickness of the needle outline. + * Gets or sets the stroke thickness of the needle outline. */ needleStrokeThickness?: number; /** - * Gets or sets the stroke thickness to use for the outline of the needle cap. + * Gets or sets the stroke thickness to use for the outline of the needle cap. */ needlePivotStrokeThickness?: number; /** - * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. + * Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ scaleEndExtent?: number; /** - * Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. + * Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ labelExtent?: number; /** - * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. + * Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. */ labelInterval?: number; /** - * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. + * Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ tickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. + * Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ tickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering ticks. + * Gets or sets the stroke thickness to use when rendering ticks. */ tickStrokeThickness?: number; /** - * Gets or sets the brush to use for the major tickmarks. + * Gets or sets the brush to use for the major tickmarks. */ tickBrush?: string; /** - * Gets or sets the brush to use for the label font. + * Gets or sets the brush to use for the label font. */ fontBrush?: string; /** - * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. + * Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ minorTickStartExtent?: number; /** - * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. + * Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ minorTickEndExtent?: number; /** - * Gets or sets the stroke thickness to use when rendering minor ticks. + * Gets or sets the stroke thickness to use when rendering minor ticks. */ minorTickStrokeThickness?: number; /** - * Gets or sets the brush to use for the minor tickmarks. + * Gets or sets the brush to use for the minor tickmarks. */ minorTickBrush?: string; /** - * Gets or sets the number of minor tickmarks to place between major tickmarks. + * Gets or sets the number of minor tickmarks to place between major tickmarks. */ minorTickCount?: number; /** - * Gets or sets the brush to use to fill the background of the scale. + * Gets or sets the brush to use to fill the background of the scale. */ scaleBrush?: string; /** - * Gets or sets the brush to use to fill the backing of the gauge. + * Gets or sets the brush to use to fill the backing of the gauge. */ backingBrush?: string; /** - * Gets or sets the brush to use for the outline of the backing. + * Gets or sets the brush to use for the outline of the backing. */ backingOutline?: string; /** - * Gets or sets the stroke thickness of the backing outline. + * Gets or sets the stroke thickness of the backing outline. */ backingStrokeThickness?: number; /** - * Gets or sets the outer extent of the gauge backing. + * Gets or sets the outer extent of the gauge backing. */ backingOuterExtent?: number; /** - * Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0. + * Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0. */ backingOversweep?: number; /** - * Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0. + * Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0. */ scaleOversweep?: number; /** - * Gets or sets the over or shape to use for the excess fill area for the scale. + * Gets or sets the over or shape to use for the excess fill area for the scale. * * Valid values: * "auto" @@ -63554,17 +63554,17 @@ interface IgRadialGauge { scaleOversweepShape?: string; /** - * Gets or sets the corner rounding radius to use for the fitted scale backings. + * Gets or sets the corner rounding radius to use for the fitted scale backings. */ backingCornerRadius?: number; /** - * Gets or sets the inner extent of the gauge backing. + * Gets or sets the inner extent of the gauge backing. */ backingInnerExtent?: number; /** - * Gets or sets the type of shape to use for the backing of the gauge. + * Gets or sets the type of shape to use for the backing of the gauge. * * Valid values: * "circular" @@ -63573,14 +63573,14 @@ interface IgRadialGauge { backingShape?: string; /** - * Gets or sets the multiplying factor to apply to the normal radius of the gauge. + * Gets or sets the multiplying factor to apply to the normal radius of the gauge. * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. */ radiusMultiplier?: number; /** - * Gets or sets the strategy to use for omitting labels if the first and last label have the same value. + * Gets or sets the strategy to use for omitting labels if the first and last label have the same value. * * Valid values: * "omitLast" @@ -63591,90 +63591,90 @@ interface IgRadialGauge { duplicateLabelOmissionStrategy?: string; /** - * Gets or sets whether needle dragging is enabled or not. + * Gets or sets whether needle dragging is enabled or not. */ isNeedleDraggingEnabled?: boolean; /** - * Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. + * Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. */ isNeedleDraggingConstrained?: boolean; /** - * Gets or sets the font. + * Gets or sets the font. */ font?: string; /** - * Gets the transition progress of the animation when the control is animating. + * Gets the transition progress of the animation when the control is animating. */ transitionProgress?: number; /** - * Gets or sets the scaling value used by the main canvas rendering context to apply a scale transform to it. + * Gets or sets the scaling value used by the main canvas rendering context to apply a scale transform to it. */ pixelScalingRatio?: number; formatLabel?: FormatLabelEvent; alignLabel?: AlignLabelEvent; /** - * Occurs when the Value property changes. + * Occurs when the Value property changes. */ valueChanged?: ValueChangedEvent; /** - * Option for igRadialGauge + * Option for igRadialGauge */ [optionName: string]: any; } interface IgRadialGaugeMethods { /** - * Returns a string containing the names of all the ranges delimited with a \n symbol. + * Returns a string containing the names of all the ranges delimited with a \n symbol. */ getRangeNames(): string; /** - * Adds a new range to the radial gauge. + * Adds a new range to the radial gauge. * * @param value */ addRange(value: Object): void; /** - * Removes a specified range. + * Removes a specified range. * * @param value */ removeRange(value: Object): void; /** - * Updates the range. + * Updates the range. * * @param value */ updateRange(value: Object): void; /** - * Clears the ranges in the radial gauge. + * Clears the ranges in the radial gauge. */ clearRanges(): void; /** - * Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. + * Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. * * @param value */ scaleValue(value: Object): void; /** - * Unscales a value from an angle in radians to the represented value along the main scale of the gauge. + * Unscales a value from an angle in radians to the represented value along the main scale of the gauge. * * @param value */ unscaleValue(value: Object): void; /** - * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. + * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * * @param x * @param y @@ -63682,7 +63682,7 @@ interface IgRadialGaugeMethods { getValueForPoint(x: Object, y: Object): number; /** - * Gets the point on the gauge for a given scale value and extent. + * Gets the point on the gauge for a given scale value and extent. * * @param value * @param extent @@ -63690,7 +63690,7 @@ interface IgRadialGaugeMethods { getPointForValue(value: Object, extent: Object): void; /** - * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. + * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. * * @param x * @param y @@ -63698,22 +63698,22 @@ interface IgRadialGaugeMethods { needleContainsPoint(x: Object, y: Object): void; /** - * Exports the visual data for the radial gauge. + * Exports the visual data for the radial gauge. */ exportVisualData(): void; /** - * Flushes the gauge. + * Flushes the gauge. */ flush(): void; /** - * Destroys widget. + * Destroys widget. */ destroy(): void; /** - * Returns true if the style was updated for the radial gauge. + * Returns true if the style was updated for the radial gauge. */ styleUpdated(): void; } @@ -64604,7 +64604,7 @@ interface JQuery { } interface IgRadialMenuItem { /** - * Gets or sets a value indicating what type of item is being provided. + * Gets or sets a value indicating what type of item is being provided. * * * Valid values: @@ -64618,137 +64618,137 @@ interface IgRadialMenuItem { type?: string; /** - * Gets or sets the unique name of the item within the menu. + * Gets or sets the unique name of the item within the menu. */ name?: string; /** - * Gets or sets the name of the child item that represents the most recently interacted with item. Note other item properties may be set to "{RecentItem}" to have them automatically set to values of the associated recent child item. + * Gets or sets the name of the child item that represents the most recently interacted with item. Note other item properties may be set to "{RecentItem}" to have them automatically set to values of the associated recent child item. */ recentItemName?: string; /** - * Returns or sets the value of the numeric item. + * Returns or sets the value of the numeric item. */ value?: number; /** - * Returns or sets the value while the user is interacting with the element. + * Returns or sets the value while the user is interacting with the element. */ pendingValue?: any; /** - * Returns or sets a boolean indicating if the children should be rotated to align with the location of this element. + * Returns or sets a boolean indicating if the children should be rotated to align with the location of this element. */ autoRotateChildren?: boolean; /** - * Returns or sets the brush used for the arc displayed within the tool when checked. + * Returns or sets the brush used for the arc displayed within the tool when checked. */ checkedHighlightBrush?: string; /** - * Returns or sets the foreground for the inner area of the item. + * Returns or sets the foreground for the inner area of the item. */ foreground?: string; /** - * Returns or sets the brush used for the arc displayed within the tool when hot tracked. + * Returns or sets the brush used for the arc displayed within the tool when hot tracked. */ highlightBrush?: string; /** - * Returns or sets the background of the inner area of the menu item. + * Returns or sets the background of the inner area of the menu item. */ innerAreaFill?: string; /** - * Returns or sets the brush for the background of the inner area of the menu item that is under the pointer. + * Returns or sets the brush for the background of the inner area of the menu item that is under the pointer. */ innerAreaHotTrackFill?: string; /** - * Returns or sets the brush for the default border of the inner area for the menu item that is under the pointer. + * Returns or sets the brush for the default border of the inner area for the menu item that is under the pointer. */ innerAreaHotTrackStroke?: string; /** - * Returns or sets the brush for the default border of the inner area for the menu item. + * Returns or sets the brush for the default border of the inner area for the menu item. */ innerAreaStroke?: string; /** - * Returns or sets the thickness of the border for the inner area for the menu item. + * Returns or sets the thickness of the border for the inner area for the menu item. */ innerAreaStrokeThickness?: number; /** - * Returns or sets a boolean indicating whether the item is enabled. + * Returns or sets a boolean indicating whether the item is enabled. */ isEnabled?: boolean; /** - * Returns or sets a boolean indicating if a tooltip may be displayed for the item. + * Returns or sets a boolean indicating if a tooltip may be displayed for the item. */ isToolTipEnabled?: boolean; /** - * Returns or sets the brush for the background of the button within the outer ring for a menu item that is under the pointer. + * Returns or sets the brush for the background of the button within the outer ring for a menu item that is under the pointer. */ outerRingButtonHotTrackFill?: string; /** - * Returns or sets the foreground of the buttons in the outer ring of the menu that is under the pointer. + * Returns or sets the foreground of the buttons in the outer ring of the menu that is under the pointer. */ outerRingButtonHotTrackForeground?: string; /** - * Returns or sets the brush for the default border of the button within the outer ring for a menu item that is under the pointer. + * Returns or sets the brush for the default border of the button within the outer ring for a menu item that is under the pointer. */ outerRingButtonHotTrackStroke?: string; /** - * Returns or sets the default background of the button within the outer ring for a menu item. + * Returns or sets the default background of the button within the outer ring for a menu item. */ outerRingButtonFill?: string; /** - * Returns or sets the brush for the foreground of the buttons in the outer ring of the menu. + * Returns or sets the brush for the foreground of the buttons in the outer ring of the menu. */ outerRingButtonForeground?: string; /** - * Returns or sets the brush for the default border of the button within the outer ring for a menu item. + * Returns or sets the brush for the default border of the button within the outer ring for a menu item. */ outerRingButtonStroke?: string; /** - * Returns or sets the width of the outline of a button in the outer ring of the menu. + * Returns or sets the width of the outline of a button in the outer ring of the menu. */ outerRingButtonStrokeThickness?: number; /** - * Returns or sets the tooltip to be displayed for the radial menu item. + * Returns or sets the tooltip to be displayed for the radial menu item. */ toolTip?: any; /** - * Returns or sets the wedge at which the item should be positioned. + * Returns or sets the wedge at which the item should be positioned. */ wedgeIndex?: number; /** - * Returns or sets the number of wedges that the item should occupy. + * Returns or sets the number of wedges that the item should occupy. */ wedgeSpan?: number; /** - * Returns or sets a boolean indicating if the RecentItem property is updated when a child item is clicked. + * Returns or sets a boolean indicating if the RecentItem property is updated when a child item is clicked. */ autoUpdateRecentItem?: boolean; /** - * Returns or sets an enumeration indicating where the child items are displayed. + * Returns or sets an enumeration indicating where the child items are displayed. * * Valid values: * "asChildren" The Items are displayed within a separate level that is accessed by clicking on the button in the outer ring of the xamRadialMenu for the parent. @@ -64758,7 +64758,7 @@ interface IgRadialMenuItem { childItemPlacement?: string; /** - * Returns or sets a value indicating how the IsChecked property may be changed. + * Returns or sets a value indicating how the IsChecked property may be changed. * * Valid values: * "none" The item is not checkable @@ -64769,73 +64769,73 @@ interface IgRadialMenuItem { checkBehavior?: string; /** - * Returns or sets a boolean indicating if the item is displayed as checked. + * Returns or sets a boolean indicating if the item is displayed as checked. */ isChecked?: boolean; /** - * Returns or sets the name used to identify which RadioButton type items will be grouped together when determining the item to uncheck when the item is checked. + * Returns or sets the name used to identify which RadioButton type items will be grouped together when determining the item to uncheck when the item is checked. */ groupName?: string; /** - * Returns or sets the header of the menu item. + * Returns or sets the header of the menu item. */ header?: any; /** - * Returns or sets the uri of the image for the item. + * Returns or sets the uri of the image for the item. */ iconUri?: string; /** - * Returns or sets the color that the item represents. + * Returns or sets the color that the item represents. * Note: When the Color property is set, several of the brush properties are changed. */ color?: any; /** - * Returns or sets the brush used to render the line that represents the PendingValue + * Returns or sets the brush used to render the line that represents the PendingValue */ pendingValueNeedleBrush?: string; /** - * Returns or sets a boolean indicating whether space should be left before the first tickmark. + * Returns or sets a boolean indicating whether space should be left before the first tickmark. */ reserveFirstSlice?: boolean; /** - * Returns or sets the amount that the PendingValue should be adjusted when incrementing or decrementing the value. + * Returns or sets the amount that the PendingValue should be adjusted when incrementing or decrementing the value. */ smallIncrement?: number; /** - * Returns or sets the brush used to render the tick marks. + * Returns or sets the brush used to render the tick marks. */ tickBrush?: string; /** - * Returns or sets the values of the ticks. + * Returns or sets the values of the ticks. */ ticks?: any; /** - * Returns or sets the starting color for the track. + * Returns or sets the starting color for the track. */ trackStartColor?: any; /** - * Returns or sets the ending color for the track. + * Returns or sets the ending color for the track. */ trackEndColor?: any; /** - * Returns or sets the brush used to represent the Value + * Returns or sets the brush used to represent the Value */ valueNeedleBrush?: string; /** - * Cancel="false" Invoked when one navigates back to the item after viewing the child items. + * Cancel="false" Invoked when one navigates back to the item after viewing the child items. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64843,7 +64843,7 @@ interface IgRadialMenuItem { closed?: any; /** - * Cancel="false" Invoked when one navigates to the view the child items. + * Cancel="false" Invoked when one navigates to the view the child items. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64851,7 +64851,7 @@ interface IgRadialMenuItem { opened?: any; /** - * Cancel="false" Occurs when the IsChecked is changed to true. + * Cancel="false" Occurs when the IsChecked is changed to true. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64859,7 +64859,7 @@ interface IgRadialMenuItem { checked?: any; /** - * Cancel="false" Occurs when the item area is clicked. + * Cancel="false" Occurs when the item area is clicked. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64867,7 +64867,7 @@ interface IgRadialMenuItem { click?: any; /** - * Cancel="false" Occurs when the IsChecked is changed to false. + * Cancel="false" Occurs when the IsChecked is changed to false. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64875,7 +64875,7 @@ interface IgRadialMenuItem { unchecked?: any; /** - * Cancel="false" Event invoked when the Color property is changed. + * Cancel="false" Event invoked when the Color property is changed. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.oldValue to obtain the previous value. @@ -64885,7 +64885,7 @@ interface IgRadialMenuItem { colorChanged?: any; /** - * Cancel="false" Occurs when the item area of a descendant color well is clicked. + * Cancel="false" Occurs when the item area of a descendant color well is clicked. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.item to obtain reference to the item. @@ -64893,7 +64893,7 @@ interface IgRadialMenuItem { colorWellClick?: any; /** - * Cancel="false" Event invoked when the Value property is changed. + * Cancel="false" Event invoked when the Value property is changed. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.oldValue to obtain the previous value. @@ -64903,7 +64903,7 @@ interface IgRadialMenuItem { valueChanged?: any; /** - * Cancel="false" Event invoked when the PendingValue property is changed. + * Cancel="false" Event invoked when the PendingValue property is changed. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. * Use ui.oldValue to obtain the previous value. @@ -64913,7 +64913,7 @@ interface IgRadialMenuItem { pendingValueChanged?: any; /** - * Option for IgRadialMenuItem + * Option for IgRadialMenuItem */ [optionName: string]: any; } @@ -64924,7 +64924,7 @@ interface ClosedEvent { interface ClosedEventUIParam { /** - * Used to obtain reference to menu widget. + * Used to obtain reference to menu widget. */ owner?: any; } @@ -64935,165 +64935,165 @@ interface OpenedEvent { interface OpenedEventUIParam { /** - * Used to obtain reference to menu widget. + * Used to obtain reference to menu widget. */ owner?: any; } interface IgRadialMenu { /** - * Gets or sets the items in the menu. + * Gets or sets the items in the menu. */ items?: IgRadialMenuItem[]; /** - * Gets or sets the name of the item within the menu whose children are currently displayed. + * Gets or sets the name of the item within the menu whose children are currently displayed. */ currentOpenMenuItemName?: string; /** - * Returns or sets the width of the center button content. + * Returns or sets the width of the center button content. */ centerButtonContentWidth?: number; /** - * Returns or sets the height of the center button content. + * Returns or sets the height of the center button content. */ centerButtonContentHeight?: number; /** - * Returns or sets the background of the center button of the menu when the IsOpen property is false. + * Returns or sets the background of the center button of the menu when the IsOpen property is false. */ centerButtonClosedFill?: string; /** - * Returns or sets the brush used for the outline of the ring of the center button when the IsOpen property is false. + * Returns or sets the brush used for the outline of the ring of the center button when the IsOpen property is false. */ centerButtonClosedStroke?: string; /** - * Returns or sets the background of the center button of the menu when the IsOpen property is true. + * Returns or sets the background of the center button of the menu when the IsOpen property is true. */ centerButtonFill?: string; /** - * Returns or sets the background of the center button of the menu when under the pointer. + * Returns or sets the background of the center button of the menu when under the pointer. */ centerButtonHotTrackFill?: string; /** - * Returns or sets the brush used for the outline of the ring of the center button when under the pointer. + * Returns or sets the brush used for the outline of the ring of the center button when under the pointer. */ centerButtonHotTrackStroke?: string; /** - * Returns or sets the brush used for the outline of the ring of the center button when the IsOpen is true. + * Returns or sets the brush used for the outline of the ring of the center button when the IsOpen is true. */ centerButtonStroke?: string; /** - * Returns or sets the width of the outline of the inner rings of the menu. + * Returns or sets the width of the outline of the inner rings of the menu. */ centerButtonStrokeThickness?: number; /** - * The font for the control + * The font for the control */ font?: string; /** - * Returns or sets a boolean indicating whether the items of the menu are currently displayed. When closed, only the center button is rendered. + * Returns or sets a boolean indicating whether the items of the menu are currently displayed. When closed, only the center button is rendered. */ isOpen?: boolean; /** - * Returns or sets the brush for the backing of the radial menu. + * Returns or sets the brush for the backing of the radial menu. */ menuBackground?: string; /** - * Returns or sets the duration of the animation performed when the IsOpen property is changed. + * Returns or sets the duration of the animation performed when the IsOpen property is changed. */ menuItemOpenCloseAnimationDuration?: number; /** - * Returns or sets the easing function applied to the animation that occurs when the IsOpen property is changed. + * Returns or sets the easing function applied to the animation that occurs when the IsOpen property is changed. */ menuItemOpenCloseAnimationEasingFunction?: any; /** - * Returns or sets the duration of the animation performed when the IsOpen property is changed. + * Returns or sets the duration of the animation performed when the IsOpen property is changed. */ menuOpenCloseAnimationDuration?: number; /** - * Returns or sets the easing function applied to the animation that occurs when the IsOpen property is changed. + * Returns or sets the easing function applied to the animation that occurs when the IsOpen property is changed. */ menuOpenCloseAnimationEasingFunction?: any; /** - * Returns or sets the minimum number of wedges displayed by the menu. + * Returns or sets the minimum number of wedges displayed by the menu. */ minWedgeCount?: number; /** - * Returns or sets the background of the outer ring of the menu. + * Returns or sets the background of the outer ring of the menu. */ outerRingFill?: string; /** - * Returns or sets the thickness of the outer ring of the menu. + * Returns or sets the thickness of the outer ring of the menu. */ outerRingThickness?: number; /** - * Returns or sets the brush used for the outline of the outer ring. + * Returns or sets the brush used for the outline of the outer ring. */ outerRingStroke?: string; /** - * Returns or sets the width of the outline of the outer ring of the menu. + * Returns or sets the width of the outline of the outer ring of the menu. */ outerRingStrokeThickness?: number; /** - * Returns or sets the starting angle of the items in degrees. + * Returns or sets the starting angle of the items in degrees. */ rotationInDegrees?: number; /** - * Returns or sets the starting angle of the items expressed as the percentage of the width of a single wedge/slice. + * Returns or sets the starting angle of the items expressed as the percentage of the width of a single wedge/slice. */ rotationAsPercentageOfWedge?: number; /** - * Returns or sets the amount of padding around each wedge in degrees. + * Returns or sets the amount of padding around each wedge in degrees. */ wedgePaddingInDegrees?: number; pixelScalingRatio?: number; /** - * Invoked when the IsOpen property is changed to false. + * Invoked when the IsOpen property is changed to false. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. */ closed?: ClosedEvent; /** - * Invoked when the IsOpen property is changed to true. + * Invoked when the IsOpen property is changed to true. * Function takes a first argument ui. * Use ui.owner to obtain reference to menu widget. */ opened?: OpenedEvent; /** - * Option for igRadialMenu + * Option for igRadialMenu */ [optionName: string]: any; } interface IgRadialMenuMethods { /** - * Gets or sets the value of a property for the item created with the specified key + * Gets or sets the value of a property for the item created with the specified key * * @param itemKey The name of the item * @param key The name of the property/option @@ -65102,22 +65102,22 @@ interface IgRadialMenuMethods { itemOption(itemKey: string, key: string, value: Object): Object; /** - * Exports visual data from the radial menu to aid in unit testing + * Exports visual data from the radial menu to aid in unit testing */ exportVisualData(): void; /** - * Forces any pending deferred work to render on the radial menu before continuing + * Forces any pending deferred work to render on the radial menu before continuing */ flush(): void; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; /** - * Notify the radial menu that style information used for rendering the menu may have been updated. + * Notify the radial menu that style information used for rendering the menu may have been updated. */ styleUpdated(): void; } @@ -65495,12 +65495,12 @@ interface HoverChangeEvent { interface HoverChangeEventUIParam { /** - * Used to get new value. + * Used to get new value. */ value?: any; /** - * Used to get old value. + * Used to get old value. */ oldValue?: any; } @@ -65511,56 +65511,56 @@ interface ValueChangeEvent { interface ValueChangeEventUIParam { /** - * Used to get new value. + * Used to get new value. */ value?: any; /** - * Used to get old value. + * Used to get old value. */ oldValue?: any; } interface IgRating { /** - * Gets a vertical or horizontal orientation for the votes. + * Gets a vertical or horizontal orientation for the votes. * Change of that option is not supported after igRating was created. * */ vertical?: boolean; /** - * Gets/Sets value (selected votes or percent). If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the value is used as number of selected votes or as a percent of the votes. + * Gets/Sets value (selected votes or percent). If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the value is used as number of selected votes or as a percent of the votes. * */ value?: number|string; /** - * Gets/Sets value-hover (hovered votes or percent of hovered votes). The default is same as value. If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the valueHover is used as number of hovered votes or as a percent of the hovered votes. + * Gets/Sets value-hover (hovered votes or percent of hovered votes). The default is same as value. If the value is of type string, it should be suitable for parsing to number. According to [valueAsPercent](ui.igrating#options:valueAsPercent) options the valueHover is used as number of hovered votes or as a percent of the hovered votes. * */ valueHover?: number|string; /** - * Gets/Sets number of votes. + * Gets/Sets number of votes. * */ voteCount?: number; /** - * Gets/Sets custom width of a vote in pixels. In case of 0 the run time style value is used. + * Gets/Sets custom width of a vote in pixels. In case of 0 the run time style value is used. * */ voteWidth?: number; /** - * Gets/Sets custom height of a vote in pixels. In case of 0 the run time style value is used. + * Gets/Sets custom height of a vote in pixels. In case of 0 the run time style value is used. * */ voteHeight?: number; /** - * Gets the direction of selected and hovered votes. Change of that option is not supported after igRating was created. + * Gets the direction of selected and hovered votes. Change of that option is not supported after igRating was created. * Value true: from left to right or from top to bottom. * Value false: from right to left or from bottom to left. * @@ -65568,7 +65568,7 @@ interface IgRating { swapDirection?: boolean; /** - * Gets/Sets percent or vote number to measure value and value-hover. + * Gets/Sets percent or vote number to measure value and value-hover. * Value true: value is measured as percent (from 0 to 1). * Value false: value is measured in number of voted (from 0 to voteCount) * @@ -65576,7 +65576,7 @@ interface IgRating { valueAsPercent?: boolean; /** - * Gets if igRating can have focus. Change of that option is not supported after igRating was created. + * Gets if igRating can have focus. Change of that option is not supported after igRating was created. * Value true: can get focus and process key events. * Value false: cannot get focus. * @@ -65584,7 +65584,7 @@ interface IgRating { focusable?: boolean; /** - * Gets/Sets precision. Precision of value and valueHover. + * Gets/Sets precision. Precision of value and valueHover. * * * Valid values: @@ -65595,7 +65595,7 @@ interface IgRating { precision?: string; /** - * Gets/Sets part of vote-size, which is considered as zero value. + * Gets/Sets part of vote-size, which is considered as zero value. * It has effect only when precision is set to "half" or "whole". * If user clicks between edge of the first vote and (sizeOfVote * precisionZeroVote), then value is set to 0. * Same is applied for mouseover as well. @@ -65604,7 +65604,7 @@ interface IgRating { precisionZeroVote?: number; /** - * Gets/Sets number of decimal places used to round value and value-hover. + * Gets/Sets number of decimal places used to round value and value-hover. * Negative value will disable that option and value will not be rounded. * Notes: * If precision is "whole" or "half" and roundedDecimalPlaces is set in range of 0..2, then 3 is used. @@ -65615,7 +65615,7 @@ interface IgRating { roundedDecimalPlaces?: number; /** - * Gets/Sets selector for css classes. + * Gets/Sets selector for css classes. * That option allows replacing all default css styles by custom values. * Application should provide css classes for all members defined in the css options with "theme" selector. * @@ -65623,14 +65623,14 @@ interface IgRating { theme?: string; /** - * Gets/Sets object which contains options supported by igValidator. + * Gets/Sets object which contains options supported by igValidator. * Note that for onblur validation depends on the [focusable](ui.igrating#options:focusable) option. * */ validatorOptions?: any; /** - * Gets/Sets custom css votes. + * Gets/Sets custom css votes. * That object should be 2-dimentional array or object with indexes, where every item of first level represents settings for a vote at that index. * Second level of an item is settings for a vote and it should contain classes for a specific state of vote. * Item at index [0] on second level is used for css class of vote in normal state. @@ -65646,7 +65646,7 @@ interface IgRating { cssVotes?: any; /** - * Event which is raised before hover value is changed. + * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. * * Function takes arguments evt and ui. @@ -65656,7 +65656,7 @@ interface IgRating { hoverChange?: HoverChangeEvent; /** - * Event which is raised before (selected) value is changed. + * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. * * Function takes arguments evt and ui. @@ -65666,25 +65666,25 @@ interface IgRating { valueChange?: ValueChangeEvent; /** - * Option for igRating + * Option for igRating */ [optionName: string]: any; } interface IgRatingMethods { /** - * Gets reference to [igValidator](ui.igvalidator) used by igRating. + * Gets reference to [igValidator](ui.igvalidator) used by igRating. * * @param destroy Request to destroy validator. */ validator(destroy?: boolean): Object; /** - * Triggers validation. + * Triggers validation. */ validate(): boolean; /** - * Gets/Sets (selected) value. + * Gets/Sets (selected) value. * * @param val New value which is rendered with selected css. * @return number|object If parameter is not 'number', then exact value rendered with selected css is returned. Otherwise, reference to igRating is returned. @@ -65692,7 +65692,7 @@ interface IgRatingMethods { value(val: number): number|Object; /** - * Gets/Sets hover value. + * Gets/Sets hover value. * * @param val New value which will be rendered with hover css when rating gets mouse. * @return number|object If parameter is not "number", then last value which was rendered with hover css is returned. Otherwise, reference to igRating is returned. @@ -65700,17 +65700,17 @@ interface IgRatingMethods { valueHover(val?: number): number|Object; /** - * Checks if igRating has focus. + * Checks if igRating has focus. */ hasFocus(): boolean; /** - * Sets focus to igRating. That has effect only when options.focusable is enabled. + * Sets focus to igRating. That has effect only when options.focusable is enabled. */ focus(): Object; /** - * Destroys igRating widget. + * Destroys igRating widget. */ destroy(): Object; } @@ -66048,32 +66048,32 @@ interface ScrollingEvent { interface ScrollingEventUIParam { /** - * Used to obtain reference to igScroll. + * Used to obtain reference to igScroll. */ owner?: any; /** - * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. + * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. */ smallIncrement?: any; /** - * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. + * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. */ bigIncrement?: any; /** - * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). + * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). */ horizontal?: any; /** - * Used to obtain how much the content will be scrolled horizontally + * Used to obtain how much the content will be scrolled horizontally */ stepX?: any; /** - * Used to obtain how much the content will be scrolled vertically + * Used to obtain how much the content will be scrolled vertically */ stepY?: any; } @@ -66084,22 +66084,22 @@ interface ScrolledEvent { interface ScrolledEventUIParam { /** - * Used to obtain reference to igScroll. + * Used to obtain reference to igScroll. */ owner?: any; /** - * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. + * Used to obtain if the content is scrolled by the arrows. 0 - none used, -1 - Arrow Up/Left, 1 - Arrow Down/Right. */ smallIncrement?: any; /** - * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. + * Used to obtain if the content is scrolled by the scrollbar track areas. 0 - none used, -1 - Scrolled Up/Left, 1 - Scrolled Down/Right. */ bigIncrement?: any; /** - * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). + * Used to obtain which axis is being used to scroll - horizontal(true) or vertical(false). */ horizontal?: any; } @@ -66110,12 +66110,12 @@ interface ThumbDragStartEvent { interface ThumbDragStartEventUIParam { /** - * Used to obtain reference to igScroll. + * Used to obtain reference to igScroll. */ owner?: any; /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). + * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ horizontal?: any; } @@ -66126,22 +66126,22 @@ interface ThumbDragMoveEvent { interface ThumbDragMoveEventUIParam { /** - * Used to obtain reference to igScroll. + * Used to obtain reference to igScroll. */ owner?: any; /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). + * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ horizontal?: any; /** - * Used to obtain how much the content will be scrolled horizontally + * Used to obtain how much the content will be scrolled horizontally */ stepX?: any; /** - * Used to obtain how much the content will be scrolled vertically + * Used to obtain how much the content will be scrolled vertically */ stepY?: any; } @@ -66152,25 +66152,25 @@ interface ThumbDragEndEvent { interface ThumbDragEndEventUIParam { /** - * Used to obtain reference to igScroll. + * Used to obtain reference to igScroll. */ owner?: any; /** - * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). + * Used to obtain which scrollbar thumb is being used - horizontal(true) or vertical(false). */ horizontal?: any; } interface IgScroll { /** - * Sets or gets if the scrollbars should be always visible (on all environments). Otherwise it will be the default behavior. Note: this option is only for the custom scrollbars set through the scrollbarType option. + * Sets or gets if the scrollbars should be always visible (on all environments). Otherwise it will be the default behavior. Note: this option is only for the custom scrollbars set through the scrollbarType option. * */ alwaysVisible?: boolean; /** - * Sets or gets what type of scrollbars should be using the igScroll (on all environments). + * Sets or gets what type of scrollbars should be using the igScroll (on all environments). * * * Valid values: @@ -66181,151 +66181,151 @@ interface IgScroll { scrollbarType?: string; /** - * Sets or gets if igScroll can modify the DOM when it is initialized on certain element so that the content can be scrollable. + * Sets or gets if igScroll can modify the DOM when it is initialized on certain element so that the content can be scrollable. * */ modifyDOM?: boolean; /** - * Sets custom value for how high is actually the content. Useful when wanting to scroll and update the shown content manually. + * Sets custom value for how high is actually the content. Useful when wanting to scroll and update the shown content manually. * */ scrollHeight?: number; /** - * Sets custom value for what width is actually the content. Useful when wanting to scroll and update the shown content manually. + * Sets custom value for what width is actually the content. Useful when wanting to scroll and update the shown content manually. * */ scrollWidth?: number; /** - * Sets gets current vertical position of the content. + * Sets gets current vertical position of the content. * */ scrollTop?: number; /** - * Sets gets current horizontal position of the content. + * Sets gets current horizontal position of the content. * */ scrollLeft?: number; /** - * Sets gets the step of the default scrolling behavior when using mouse wheel + * Sets gets the step of the default scrolling behavior when using mouse wheel * */ wheelStep?: number; /** - * Sets gets the step of the default scrolling behavior when using any of the custom scrollbar arrows + * Sets gets the step of the default scrolling behavior when using any of the custom scrollbar arrows * */ smallIncrementStep?: number; /** - * Sets gets the step of the default scrolling behavior when using any of the custom scrollbar track areas. + * Sets gets the step of the default scrolling behavior when using any of the custom scrollbar track areas. * */ bigIncrementStep?: number; /** - * Sets gets if smoother scrolling with small intertia should be used when using mouse wheel + * Sets gets if smoother scrolling with small intertia should be used when using mouse wheel * */ smoothing?: boolean; /** - * Sets or gets the modifier for how many pixels will be scrolled when using the mouse wheel once. This is used only for the smooth scrolling behavior. + * Sets or gets the modifier for how many pixels will be scrolled when using the mouse wheel once. This is used only for the smooth scrolling behavior. * */ smoothingStep?: number; /** - * Sets or gets the modifier for how long the scroll ‘animation’ lasts when using the mouse wheel once. This is used only for the smooth scrolling behavior. + * Sets or gets the modifier for how long the scroll ‘animation’ lasts when using the mouse wheel once. This is used only for the smooth scrolling behavior. * */ smoothingDuration?: number; /** - * Sets gets the modifier for how much the inertia scrolls on mobile devices + * Sets gets the modifier for how much the inertia scrolls on mobile devices * */ inertiaStep?: number; /** - * Sets gets the modifier for how long the inertia last on mobile devices + * Sets gets the modifier for how long the inertia last on mobile devices * */ inertiaDuration?: number; /** - * Sets gets how much pixels of toleration there will be when initially swiping horizontally. This is to improve swiping up/down without scrolling left/right when not intended due to small deviation left/right + * Sets gets how much pixels of toleration there will be when initially swiping horizontally. This is to improve swiping up/down without scrolling left/right when not intended due to small deviation left/right * */ swipeToleranceX?: number; /** - * Sets gets at least how many times the horizontal speed should be bigger so the inertia proceeds only horizontally without scrolling vertically. This is to improve interactions due to not perfectly swiping left/right with some deviation down/up + * Sets gets at least how many times the horizontal speed should be bigger so the inertia proceeds only horizontally without scrolling vertically. This is to improve interactions due to not perfectly swiping left/right with some deviation down/up * */ inertiaDeltaX?: number; /** - * Sets gets at least how many times the vertical speed should be bigger so the inertia proceeds only vertically without scrolling horizontally. This is to improve interactions due to not perfectly swiping down/up with some deviation left/right + * Sets gets at least how many times the vertical speed should be bigger so the inertia proceeds only vertically without scrolling horizontally. This is to improve interactions due to not perfectly swiping down/up with some deviation left/right * */ inertiaDeltaY?: number; /** - * Sets gets elements that are linked to the main content horizontally. When the content is scrolled on X axis the linked elements scroll accordingly. + * Sets gets elements that are linked to the main content horizontally. When the content is scrolled on X axis the linked elements scroll accordingly. * */ syncedElemsH?: any[]; /** - * Sets gets elements that are linked to the main content vertically. When the content is scrolled on Y axis the linked elements scroll accordingly. + * Sets gets elements that are linked to the main content vertically. When the content is scrolled on Y axis the linked elements scroll accordingly. * */ syncedElemsV?: any[]; /** - * Sets gets html or jQuery element which is used for horizontal scrolling. + * Sets gets html or jQuery element which is used for horizontal scrolling. * */ scrollbarH?: string; /** - * Sets gets html or jQuery element which is used for vertical scrolling. + * Sets gets html or jQuery element which is used for vertical scrolling. * */ scrollbarV?: string; /** - * Sets gets if only the linked horizontal scrollbar should be used for horizontal scrolling. Note: The behavior when the linked scrollbar is scrolled in this case should be handled manually. + * Sets gets if only the linked horizontal scrollbar should be used for horizontal scrolling. Note: The behavior when the linked scrollbar is scrolled in this case should be handled manually. * */ scrollOnlyHBar?: boolean; /** - * Sets gets if only the linked vertical scrollbar should be used for vertical scrolling. Note: The behavior when the linked scrollbar is scrolled in this case should be handled manually. + * Sets gets if only the linked vertical scrollbar should be used for vertical scrolling. Note: The behavior when the linked scrollbar is scrolled in this case should be handled manually. * */ scrollOnlyVBar?: boolean; /** - * Sets gets html or jQuery element to which the horizontal scrollbar will be appended to. + * Sets gets html or jQuery element to which the horizontal scrollbar will be appended to. * */ scrollbarHParent?: string; /** - * Sets gets html or jQuery element to which the vertical scrollbar will be appended to. + * Sets gets html or jQuery element to which the vertical scrollbar will be appended to. * */ scrollbarVParent?: string; /** - * Event which is raised after the scroller has been rendered fully + * Event which is raised after the scroller has been rendered fully * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. * Use args.owner to obtain reference to igScroll. @@ -66333,7 +66333,7 @@ interface IgScroll { rendered?: RenderedEvent; /** - * Event which is raised before scrolling or before each step when having inertia. + * Event which is raised before scrolling or before each step when having inertia. * Return false in order to cancel action. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. @@ -66347,7 +66347,7 @@ interface IgScroll { scrolling?: ScrollingEvent; /** - * Event which is raised after scrolling has stopped. + * Event which is raised after scrolling has stopped. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. * Use args.owner to obtain reference to igScroll. @@ -66358,7 +66358,7 @@ interface IgScroll { scrolled?: ScrolledEvent; /** - * Event which is raised when there is mouse click on the scrollbar's thumb drag. + * Event which is raised when there is mouse click on the scrollbar's thumb drag. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. * Use args.owner to obtain reference to igScroll. @@ -66367,7 +66367,7 @@ interface IgScroll { thumbDragStart?: ThumbDragStartEvent; /** - * Event which is raised when the thumb drag is being moved. + * Event which is raised when the thumb drag is being moved. * Return false in order to cancel action. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. @@ -66379,7 +66379,7 @@ interface IgScroll { thumbDragMove?: ThumbDragMoveEvent; /** - * Event which is raised on mouse up from the scrollbar's thumb drag. + * Event which is raised on mouse up from the scrollbar's thumb drag. * Function takes arguments evt and args. * Use evt.originalEvent (with validation for not null of evt) to obtain reference to event of browser. * Use args.owner to obtain reference to igScroll. @@ -66388,7 +66388,7 @@ interface IgScroll { thumbDragEnd?: ThumbDragEndEvent; /** - * Option for igScroll + * Option for igScroll */ [optionName: string]: any; } @@ -66918,7 +66918,7 @@ interface IgLoading { includeVerticalOffset?: boolean; /** - * Option for igLoading + * Option for igLoading */ [optionName: string]: any; } @@ -66936,27 +66936,27 @@ interface JQuery { interface IgSliderBookmarks { /** - * Get or set the bookmark value. Should be between slider min and max values. + * Get or set the bookmark value. Should be between slider min and max values. */ value?: number; /** - * Get or set the bookmark title. Show in tooltip on hover. + * Get or set the bookmark title. Show in tooltip on hover. */ title?: string; /** - * Get or set whether the bookmark is disabled or not. + * Get or set whether the bookmark is disabled or not. */ disabled?: boolean; /** - * Get or set a custom css class to be applied to the bookmark anchor element. + * Get or set a custom css class to be applied to the bookmark anchor element. */ css?: string; /** - * Option for IgSliderBookmarks + * Option for IgSliderBookmarks */ [optionName: string]: any; } @@ -67005,82 +67005,82 @@ interface BookmarkClickEventUIParam { interface IgSlider { /** - * Get or set whether the slide handle will animate when it is moved. + * Get or set whether the slide handle will animate when it is moved. */ animate?: boolean; /** - * Get or set the slider range maximum value. + * Get or set the slider range maximum value. */ max?: number; /** - * Get or set the slider range minimum value. + * Get or set the slider range minimum value. */ min?: number; /** - * Get or set the slider orientation. + * Get or set the slider orientation. */ orientation?: any; /** - * Get or set the step with which the value is increased. + * Get or set the step with which the value is increased. */ step?: number; /** - * Get or set the slider value. + * Get or set the slider value. */ value?: number; /** - * Get or set the bookmarks array. + * Get or set the bookmarks array. */ bookmarks?: IgSliderBookmarks; /** - * Get or set the whether to show bookmarks title on bookmark hover or not. + * Get or set the whether to show bookmarks title on bookmark hover or not. */ showBookmarkTitle?: boolean; /** - * Get or set whether the handle will be moved to the bookmark position when a bookmark is clicked. + * Get or set whether the handle will be moved to the bookmark position when a bookmark is clicked. */ syncHandleWithBookmark?: boolean; /** - * Defines the slide start event. + * Defines the slide start event. */ start?: StartEvent; /** - * Defines the slide event. Fired when the user is sliding with mouse. + * Defines the slide event. Fired when the user is sliding with mouse. */ slide?: SlideEvent; /** - * Defines the slide stop event. Fired to mark the end of a sliding action. + * Defines the slide stop event. Fired to mark the end of a sliding action. */ stop?: StopEvent; /** - * Defines the slider value change event. Fired when the value of the slider changes. It fires after the slide event. + * Defines the slider value change event. Fired when the value of the slider changes. It fires after the slide event. */ change?: ChangeEvent; /** - * Defines the slider bookmark hit event. Fired when the slider handle passes after the bookmark value. + * Defines the slider bookmark hit event. Fired when the slider handle passes after the bookmark value. */ bookmarkHit?: BookmarkHitEvent; /** - * Defines the slider bookmark click event. Fired when a bookmark is clicked. + * Defines the slider bookmark click event. Fired when a bookmark is clicked. */ bookmarkClick?: BookmarkClickEvent; /** - * Option for igSlider + * Option for igSlider */ [optionName: string]: any; } @@ -67106,14 +67106,14 @@ interface IgProgressBar { range?: boolean; /** - * A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. + * A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. */ queue?: boolean; endValue?: number; change?: ChangeEvent; /** - * Option for igProgressBar + * Option for igProgressBar */ [optionName: string]: any; } @@ -67132,7 +67132,7 @@ interface IgButtonLink { title?: any; /** - * Option for IgButtonLink + * Option for IgButtonLink */ [optionName: string]: any; } @@ -67142,7 +67142,7 @@ interface IgButtonIcons { secondary?: any; /** - * Option for IgButtonIcons + * Option for IgButtonIcons */ [optionName: string]: any; } @@ -67159,7 +67159,7 @@ interface IgButton { title?: boolean; /** - * Option for igButton + * Option for igButton */ [optionName: string]: any; } @@ -67177,7 +67177,7 @@ interface IgTooltip { arrowLocation?: string; /** - * Option for igTooltip + * Option for igTooltip */ [optionName: string]: any; } @@ -67205,7 +67205,7 @@ interface MouseWrapper { capture?: CaptureEvent; /** - * Option for mouseWrapper + * Option for mouseWrapper */ [optionName: string]: any; } @@ -67218,40 +67218,40 @@ interface JQuery { interface IgResponsiveContainer { /** - * The time between two resize checks in milliseconds. + * The time between two resize checks in milliseconds. */ pollingInterval?: number; /** - * Option for igResponsiveContainer + * Option for igResponsiveContainer */ [optionName: string]: any; } interface IgResponsiveContainerMethods { /** - * Destroys the ResponsiveContainer widget + * Destroys the ResponsiveContainer widget */ destroy(): void; /** - * Starts the automatic size check procedure + * Starts the automatic size check procedure */ startPoller(): void; /** - * Stops the automatic size check procedure + * Stops the automatic size check procedure */ stopPoller(): void; /** - * Removes a callback from the callbacks collection. + * Removes a callback from the callbacks collection. * * @param callbackId The callback id to remove. */ removeCallback(callbackId: number): void; /** - * Adds a callback to the callback collection. + * Adds a callback to the callback collection. * * @param callback The function to call when requirements are met. * @param owner The owner object of the function. @@ -67790,77 +67790,77 @@ interface JQuery { } interface IgSparkline { /** - * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). + * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ width?: string|number; /** - * The height of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). + * The height of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ height?: string|number; /** - * Gets or sets the sparkline brush. + * Gets or sets the sparkline brush. */ brush?: string; /** - * Gets or sets the negative brush of the sparkline. + * Gets or sets the negative brush of the sparkline. */ negativeBrush?: string; /** - * Gets or sets the marker brush of the sparkline. + * Gets or sets the marker brush of the sparkline. */ markerBrush?: string; /** - * Gets or sets the negative marker brush of the sparkline. + * Gets or sets the negative marker brush of the sparkline. */ negativeMarkerBrush?: string; /** - * Gets or sets the first marker brush of the sparkline. + * Gets or sets the first marker brush of the sparkline. */ firstMarkerBrush?: string; /** - * Gets or sets the last marker brush of the sparkline. + * Gets or sets the last marker brush of the sparkline. */ lastMarkerBrush?: string; /** - * Gets or sets the high marker brush of the sparkline. + * Gets or sets the high marker brush of the sparkline. */ highMarkerBrush?: string; /** - * Gets or sets the low marker brush of the sparkline. + * Gets or sets the low marker brush of the sparkline. */ lowMarkerBrush?: string; /** - * Gets or sets the trendline brush of the sparkline. + * Gets or sets the trendline brush of the sparkline. */ trendLineBrush?: string; /** - * Gets or sets the horizontal axis line brush of the sparkline. + * Gets or sets the horizontal axis line brush of the sparkline. */ horizontalAxisBrush?: string; /** - * Gets or sets the vertical axis line brush of the sparkline. + * Gets or sets the vertical axis line brush of the sparkline. */ verticalAxisBrush?: string; /** - * Gets or sets the normal range brush of the sparkline. + * Gets or sets the normal range brush of the sparkline. */ normalRangeFill?: string; /** - * Gets or sets the display state of the horizontal axis. + * Gets or sets the display state of the horizontal axis. * * Valid values: * "visible" @@ -67869,7 +67869,7 @@ interface IgSparkline { horizontalAxisVisibility?: string; /** - * Gets or sets the display state of the vertical axis. + * Gets or sets the display state of the vertical axis. * * Valid values: * "visible" @@ -67878,7 +67878,7 @@ interface IgSparkline { verticalAxisVisibility?: string; /** - * Gets or sets the marker visibility of the sparkline. + * Gets or sets the marker visibility of the sparkline. * * Valid values: * "visible" @@ -67887,7 +67887,7 @@ interface IgSparkline { markerVisibility?: string; /** - * Gets or sets the negative marker visibility of the sparkline. + * Gets or sets the negative marker visibility of the sparkline. * * Valid values: * "visible" @@ -67896,7 +67896,7 @@ interface IgSparkline { negativeMarkerVisibility?: string; /** - * Gets or sets the first marker visibility of the sparkline. + * Gets or sets the first marker visibility of the sparkline. * * Valid values: * "visible" @@ -67905,7 +67905,7 @@ interface IgSparkline { firstMarkerVisibility?: string; /** - * Gets or sets the last marker visibility of the sparkline. + * Gets or sets the last marker visibility of the sparkline. * * Valid values: * "visible" @@ -67914,7 +67914,7 @@ interface IgSparkline { lastMarkerVisibility?: string; /** - * Gets or sets the low marker visibility of the sparkline. + * Gets or sets the low marker visibility of the sparkline. * * Valid values: * "visible" @@ -67923,7 +67923,7 @@ interface IgSparkline { lowMarkerVisibility?: string; /** - * Gets or sets the high marker visibility of the sparkline. + * Gets or sets the high marker visibility of the sparkline. * * Valid values: * "visible" @@ -67932,7 +67932,7 @@ interface IgSparkline { highMarkerVisibility?: string; /** - * Gets or sets the normal range visibility of the sparkline. + * Gets or sets the normal range visibility of the sparkline. * * Valid values: * "visible" @@ -67941,57 +67941,57 @@ interface IgSparkline { normalRangeVisibility?: string; /** - * Gets or sets the position of the normal range on the sparkline. + * Gets or sets the position of the normal range on the sparkline. */ displayNormalRangeInFront?: boolean; /** - * Gets or sets the marker size of the sparkline. + * Gets or sets the marker size of the sparkline. */ markerSize?: number; /** - * Gets or sets the first marker size of the sparkline. + * Gets or sets the first marker size of the sparkline. */ firstMarkerSize?: number; /** - * Gets or sets the last marker size of the sparkline. + * Gets or sets the last marker size of the sparkline. */ lastMarkerSize?: number; /** - * Gets or sets the high marker size of the sparkline. + * Gets or sets the high marker size of the sparkline. */ highMarkerSize?: number; /** - * Gets or sets the low marker size of the sparkline. + * Gets or sets the low marker size of the sparkline. */ lowMarkerSize?: number; /** - * Gets or sets the negative marker size of the sparkline. + * Gets or sets the negative marker size of the sparkline. */ negativeMarkerSize?: number; /** - * Gets or sets the line thickness of the sparkline. + * Gets or sets the line thickness of the sparkline. */ lineThickness?: number; /** - * Gets or sets the string path to the value column. + * Gets or sets the string path to the value column. */ valueMemberPath?: string; /** - * String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis. + * String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis. */ labelMemberPath?: string; /** - * Gets or sets the type of trendline used by the sparkline. + * Gets or sets the type of trendline used by the sparkline. * * Valid values: * "none" @@ -68012,27 +68012,27 @@ interface IgSparkline { trendLineType?: string; /** - * Gets or sets the trendline period used by the sparkline. + * Gets or sets the trendline period used by the sparkline. */ trendLinePeriod?: number; /** - * Gets or sets the thickness of the sparkline's trendline. + * Gets or sets the thickness of the sparkline's trendline. */ trendLineThickness?: number; /** - * Gets or sets the minimum value of the normal range. + * Gets or sets the minimum value of the normal range. */ normalRangeMinimum?: number; /** - * Gets or sets the maximum value of the normal range. + * Gets or sets the maximum value of the normal range. */ normalRangeMaximum?: number; /** - * Gets or sets the display type of the sparkline. + * Gets or sets the display type of the sparkline. * * Valid values: * "line" Display the sparkline as a line. @@ -68043,7 +68043,7 @@ interface IgSparkline { displayType?: string; /** - * Gets or sets the way null values are interpreted. + * Gets or sets the way null values are interpreted. * * Valid values: * "linearInterpolate" @@ -68052,63 +68052,63 @@ interface IgSparkline { unknownValuePlotting?: string; /** - * The value or content to display on the vertical axis. + * The value or content to display on the vertical axis. * This can be set to a formatted string, such as "{0:n}", or it can be set to a DataTemplate. */ verticalAxisLabel?: any; /** - * The value or content to display on the horizontal axis. + * The value or content to display on the horizontal axis. * This can be set to a formatted string, such as "{0}", or it can be set to a DataTemplate. */ horizontalAxisLabel?: any; /** - * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. + * Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. */ formatLabel?: any; pixelScalingRatio?: number; /** - * Gets sets template for tooltip associated with chart item. + * Gets sets template for tooltip associated with chart item. * Example: "Value: $(ValueMemberPathInDataSource)" */ tooltipTemplate?: string; /** - * Gets sets maximum number of displayed records in chart. + * Gets sets maximum number of displayed records in chart. */ maxRecCount?: number; /** - * Gets sets a valid data source. + * Gets sets a valid data source. * That can be instance of array or primitives, array of objects, instance of $.ig.DataSource, or any other data accepted by $.ig.DataSource. * Note: if it is set to string and "dataSourceType" option is not set, then $.ig.JSONPDataSource is used. */ dataSource?: any; /** - * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property + * Gets sets data source type (such as "json", "xml", etc). Please refer to the documentation of $.ig.DataSource and its type property */ dataSourceType?: string; /** - * Gets sets url which is used for sending JSON on request for remote data. + * Gets sets url which is used for sending JSON on request for remote data. */ dataSourceUrl?: string; /** - * See $.ig.DataSource. property in the response specifying the total number of records on the server. + * See $.ig.DataSource. property in the response specifying the total number of records on the server. */ responseTotalRecCountKey?: string; /** - * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. + * See $.ig.DataSource. This is basically the property in the responses where data records are held, if the response is wrapped. */ responseDataKey?: string; /** - * Event which is raised before data binding. + * Event which is raised before data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to igSparkline. * Use ui.dataSource to obtain reference to instance of $.ig.DataSource. @@ -68116,7 +68116,7 @@ interface IgSparkline { dataBinding?: DataBindingEvent; /** - * Event which is raised after data binding. + * Event which is raised after data binding. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to igSparkline. * Use ui.data to obtain reference to array actual data which is displayed by chart. @@ -68125,7 +68125,7 @@ interface IgSparkline { dataBound?: DataBoundEvent; /** - * Event which is raised before tooltip is updated. + * Event which is raised before tooltip is updated. * Return false in order to cancel updating and hide tooltip. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -68138,7 +68138,7 @@ interface IgSparkline { updateTooltip?: UpdateTooltipEvent; /** - * Event which is raised before tooltip is hidden. + * Event which is raised before tooltip is hidden. * Return false in order to cancel hiding and keep tooltip visible. * Function takes first argument null and second argument ui. * Use ui.owner to obtain reference to chart widget. @@ -68148,7 +68148,7 @@ interface IgSparkline { hideTooltip?: HideTooltipEvent; /** - * Option for igSparkline + * Option for igSparkline */ [optionName: string]: any; } @@ -68156,33 +68156,33 @@ interface IgSparklineMethods { destroy(): void; /** - * Find index of item within actual data used by chart. + * Find index of item within actual data used by chart. * * @param item The reference to item. */ findIndexOfItem(item: Object): number; /** - * Get item within actual data used by chart. That is similar to this.getData()[ index ]. + * Get item within actual data used by chart. That is similar to this.getData()[ index ]. * * @param index Index of data item. */ getDataItem(index: Object): Object; /** - * Get reference of actual data used by chart. + * Get reference of actual data used by chart. */ getData(): any[]; /** - * Adds a new item to the data source and notifies the chart. + * Adds a new item to the data source and notifies the chart. * * @param item The item that we want to add to the data source. */ addItem(item: Object): Object; /** - * Inserts a new item to the data source and notifies the chart. + * Inserts a new item to the data source and notifies the chart. * * @param item the new item that we want to insert in the data source. * @param index The index in the data source where the new item will be inserted. @@ -68190,14 +68190,14 @@ interface IgSparklineMethods { insertItem(item: Object, index: number): Object; /** - * Deletes an item from the data source and notifies the chart. + * Deletes an item from the data source and notifies the chart. * * @param index The index in the data source from where the item will be been removed. */ removeItem(index: number): Object; /** - * Updates an item in the data source and notifies the chart. + * Updates an item in the data source and notifies the chart. * * @param index The index of the item in the data source that we want to change. * @param item The new item object that will be set in the data source. @@ -68205,7 +68205,7 @@ interface IgSparklineMethods { setItem(index: number, item: Object): Object; /** - * Notifies the chart that an item has been set in an associated data source. + * Notifies the chart that an item has been set in an associated data source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source that has been changed. @@ -68215,16 +68215,16 @@ interface IgSparklineMethods { notifySetItem(dataSource: Object, index: number, newItem: Object, oldItem: Object): Object; /** - * Notifies the chart that the items have been cleared from an associated data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the chart that the items have been cleared from an associated data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. */ notifyClearItems(dataSource: Object): Object; /** - * Notifies the target axis or series that an item has been inserted at the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been inserted at the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source where the new item has been inserted. @@ -68233,8 +68233,8 @@ interface IgSparklineMethods { notifyInsertItem(dataSource: Object, index: number, newItem: Object): Object; /** - * Notifies the target axis or series that an item has been removed from the specified index in its data source. - * It's not necessary to notify more than one target of a change if they share the same items source. + * Notifies the target axis or series that an item has been removed from the specified index in its data source. + * It's not necessary to notify more than one target of a change if they share the same items source. * * @param dataSource The data source in which the change happened. * @param index The index in the items source from where the old item has been removed. @@ -68243,12 +68243,12 @@ interface IgSparklineMethods { notifyRemoveItem(dataSource: Object, index: number, oldItem: Object): Object; /** - * Get reference to chart object. + * Get reference to chart object. */ chart(): Object; /** - * Binds data to the chart + * Binds data to the chart */ dataBind(): void; } @@ -68985,47 +68985,47 @@ interface JQuery { } interface IgSplitButtonItem { /** - * Item name + * Item name */ name?: string; /** - * Item display label + * Item display label */ label?: string; /** - * Css class to represent the iconClass of the item + * Css class to represent the iconClass of the item */ iconClass?: string; /** - * Option for IgSplitButtonItem + * Option for IgSplitButtonItem */ [optionName: string]: any; } interface IgSplitButton { /** - * Button items. + * Button items. * */ items?: IgSplitButtonItem[]; /** - * Default button item name. + * Default button item name. * */ defaultItemName?: string; /** - * Specifies whether the default button will be switched when another button is selected. + * Specifies whether the default button will be switched when another button is selected. * */ swapDefaultEnabled?: boolean; /** - * Event fired when the button is clicked. + * Event fired when the button is clicked. * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. @@ -69033,7 +69033,7 @@ interface IgSplitButton { click?: ClickEvent; /** - * Event fired after the button is expanded. + * Event fired after the button is expanded. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -69041,7 +69041,7 @@ interface IgSplitButton { expanded?: ExpandedEvent; /** - * Event fired before a button item is expanded. + * Event fired before a button item is expanded. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -69049,7 +69049,7 @@ interface IgSplitButton { expanding?: ExpandingEvent; /** - * Event fired after the button is collapsed. + * Event fired after the button is collapsed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -69057,7 +69057,7 @@ interface IgSplitButton { collapsed?: CollapsedEvent; /** - * Event fired before a button item is collapsed. + * Event fired before a button item is collapsed. * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. @@ -69065,13 +69065,13 @@ interface IgSplitButton { collapsing?: CollapsingEvent; /** - * Option for igSplitButton + * Option for igSplitButton */ [optionName: string]: any; } interface IgSplitButtonMethods { /** - * Switch to given igToolbar button. + * Switch to given igToolbar button. * * @param button . The button jQuery element. */ @@ -69079,28 +69079,28 @@ interface IgSplitButtonMethods { widget(): void; /** - * Toggle widget state between collapsed and expanded. + * Toggle widget state between collapsed and expanded. * * @param e The igSplitButton to be expanded/collapsed. */ toggle(e: Object): Object; /** - * Collapse the widget. + * Collapse the widget. * * @param e Indicates the browser event which triggered this action (not API). */ collapse(e?: Object): Object; /** - * Expands the widget. + * Expands the widget. * * @param e Indicates the browser event which triggered this action (not API). */ expand(e?: Object): Object; /** - * Destroy the widget. + * Destroy the widget. */ destroy(): void; } @@ -69255,43 +69255,43 @@ interface JQuery { } interface IgSplitterPanel { /** - * Gets the size of the panel + * Gets the size of the panel * */ size?: string|number; /** - * Gets the minimum size that the panel can have + * Gets the minimum size that the panel can have * */ min?: string|number; /** - * Gets the maximum size that the panel can have + * Gets the maximum size that the panel can have * */ max?: string|number; /** - * Gets whether the panel can be resized + * Gets whether the panel can be resized * */ resizable?: boolean; /** - * Gets whether the panel is initially collapsed + * Gets whether the panel is initially collapsed * */ collapsed?: boolean; /** - * Gets whether the panel can be collapsed + * Gets whether the panel can be collapsed * */ collapsible?: boolean; /** - * Option for IgSplitterPanel + * Option for IgSplitterPanel */ [optionName: string]: any; } @@ -69302,7 +69302,7 @@ interface ResizeStartedEvent { interface ResizeStartedEventUIParam { /** - * Used to get a reference to the splitter instance. + * Used to get a reference to the splitter instance. */ owner?: any; } @@ -69313,7 +69313,7 @@ interface ResizingEvent { interface ResizingEventUIParam { /** - * Used to get a reference to the splitter instance. + * Used to get a reference to the splitter instance. */ owner?: any; } @@ -69324,7 +69324,7 @@ interface ResizeEndedEvent { interface ResizeEndedEventUIParam { /** - * Used to get a reference to the splitter instance. + * Used to get a reference to the splitter instance. */ owner?: any; } @@ -69335,7 +69335,7 @@ interface LayoutRefreshingEvent { interface LayoutRefreshingEventUIParam { /** - * Used to get a reference to the splitter instance. + * Used to get a reference to the splitter instance. */ owner?: any; } @@ -69346,14 +69346,14 @@ interface LayoutRefreshedEvent { interface LayoutRefreshedEventUIParam { /** - * Used to get a reference to the splitter instance. + * Used to get a reference to the splitter instance. */ owner?: any; } interface IgSplitter { /** - * Gets/Sets the width of the container. + * Gets/Sets the width of the container. * * * Valid values: @@ -69362,7 +69362,7 @@ interface IgSplitter { width?: string|number; /** - * Gets/Sets the height of the container. + * Gets/Sets the height of the container. * * * Valid values: @@ -69371,7 +69371,7 @@ interface IgSplitter { height?: string|number; /** - * Specifies the orientation of the splitter. + * Specifies the orientation of the splitter. * * * Valid values: @@ -69381,25 +69381,25 @@ interface IgSplitter { orientation?: string; /** - * Array of objects options that specify the panels settings. The panels are no more than two. Settings are specified via enumeration. + * Array of objects options that specify the panels settings. The panels are no more than two. Settings are specified via enumeration. * */ panels?: IgSplitterPanel[]; /** - * Specifies drag delta of the split bar. In order to start dragging "move", the mouse has to be moved specific distance from its original position. + * Specifies drag delta of the split bar. In order to start dragging "move", the mouse has to be moved specific distance from its original position. * */ dragDelta?: number; /** - * Specifies whether the other splitters on the page will be resized as this splitter resizes. + * Specifies whether the other splitters on the page will be resized as this splitter resizes. * */ resizeOtherSplitters?: boolean; /** - * Fired after collapsing is performed + * Fired after collapsing is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69408,7 +69408,7 @@ interface IgSplitter { collapsed?: CollapsedEvent; /** - * Fired after expanding is performed + * Fired after expanding is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69417,7 +69417,7 @@ interface IgSplitter { expanded?: ExpandedEvent; /** - * Fired before split bar move is performed + * Fired before split bar move is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69425,7 +69425,7 @@ interface IgSplitter { resizeStarted?: ResizeStartedEvent; /** - * Fired while split bar move is performed + * Fired while split bar move is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69433,7 +69433,7 @@ interface IgSplitter { resizing?: ResizingEvent; /** - * Fired after split bar move is performed + * Fired after split bar move is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69441,7 +69441,7 @@ interface IgSplitter { resizeEnded?: ResizeEndedEvent; /** - * Fired before the panels are refreshed because of browser"s resizing. + * Fired before the panels are refreshed because of browser"s resizing. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69449,7 +69449,7 @@ interface IgSplitter { layoutRefreshing?: LayoutRefreshingEvent; /** - * Fired after the panels are refreshed because of browser"s resizing. + * Fired after the panels are refreshed because of browser"s resizing. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69457,61 +69457,61 @@ interface IgSplitter { layoutRefreshed?: LayoutRefreshedEvent; /** - * Option for igSplitter + * Option for igSplitter */ [optionName: string]: any; } interface IgSplitterMethods { /** - * Returns the element that represents this widget. + * Returns the element that represents this widget. */ widget(): Object; /** - * Expand the specified panel by index. + * Expand the specified panel by index. * * @param index Specifies the index of the panel to expand. */ expandAt(index: Object): void; /** - * Collapse the specified panel. + * Collapse the specified panel. * * @param index Specifies the index of the panel to collapse. */ collapseAt(index: Object): void; /** - * Retrieves the jQuery element of the first panel. + * Retrieves the jQuery element of the first panel. */ firstPanel(): Object; /** - * Retrieves the jQuery element of the second panel. + * Retrieves the jQuery element of the second panel. */ secondPanel(): Object; /** - * Refresh splitter layout, use this method to re-render the splitter if some changes to the layout are applied. + * Refresh splitter layout, use this method to re-render the splitter if some changes to the layout are applied. */ refreshLayout(): void; /** - * You can set new size of the first panel after the splitter is rendered. + * You can set new size of the first panel after the splitter is rendered. * * @param size Specifies the new size of the first panel. */ setFirstPanelSize(size: Object): void; /** - * You can set new size of the second panel after the splitter is rendered. + * You can set new size of the second panel after the splitter is rendered. * * @param size Specifies the new size of the second panel. */ setSecondPanelSize(size: Object): void; /** - * Destroys the igSplitter widget + * Destroys the igSplitter widget */ destroy(): void; } @@ -69751,7 +69751,7 @@ interface JQuery { } interface IgTileManagerSplitterOptionsEvents { /** - * Event fired after collapsing is performed. Not cancellable. + * Event fired after collapsing is performed. Not cancellable. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69760,7 +69760,7 @@ interface IgTileManagerSplitterOptionsEvents { collapsed?: any; /** - * Event fired after expanding is performed. Not cancellable. + * Event fired after expanding is performed. Not cancellable. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. @@ -69769,38 +69769,38 @@ interface IgTileManagerSplitterOptionsEvents { expanded?: any; /** - * Option for IgTileManagerSplitterOptionsEvents + * Option for IgTileManagerSplitterOptionsEvents */ [optionName: string]: any; } interface IgTileManagerSplitterOptions { /** - * Gets/Sets whether the splitter should be enabled. + * Gets/Sets whether the splitter should be enabled. * */ enabled?: boolean; /** - * Gets whether the splitter can be collapsible. + * Gets whether the splitter can be collapsible. * */ collapsible?: boolean; /** - * Gets whether the splitter should be initially collapsed. + * Gets whether the splitter should be initially collapsed. * */ collapsed?: boolean; /** - * Gets/Sets splitter events. + * Gets/Sets splitter events. * */ events?: IgTileManagerSplitterOptionsEvents; /** - * Option for IgTileManagerSplitterOptions + * Option for IgTileManagerSplitterOptions */ [optionName: string]: any; } @@ -69811,12 +69811,12 @@ interface TileRenderingEvent { interface TileRenderingEventUIParam { /** - * Used to get a reference to the tile manager performing rendering. + * Used to get a reference to the tile manager performing rendering. */ owner?: any; /** - * Used to get a reference to the tile being rendered + * Used to get a reference to the tile being rendered */ tile?: any; } @@ -69827,12 +69827,12 @@ interface TileRenderedEvent { interface TileRenderedEventUIParam { /** - * Used to get a reference to the tile manager performing rendering. + * Used to get a reference to the tile manager performing rendering. */ owner?: any; /** - * Used to get a reference to the rendered tile + * Used to get a reference to the rendered tile */ tile?: any; } @@ -69843,17 +69843,17 @@ interface TileMaximizingEvent { interface TileMaximizingEventUIParam { /** - * Used to get a reference to the tile manager performing the maximizing the tile belongs to. + * Used to get a reference to the tile manager performing the maximizing the tile belongs to. */ owner?: any; /** - * Used to get the jQuery element of the tile being maximized + * Used to get the jQuery element of the tile being maximized */ tile?: any; /** - * Used to get reference to the tile that is minimizing simultaneously or null if no tile is minimizing. + * Used to get reference to the tile that is minimizing simultaneously or null if no tile is minimizing. */ minimizingTile?: any; } @@ -69864,12 +69864,12 @@ interface TileMaximizedEvent { interface TileMaximizedEventUIParam { /** - * Used to get a reference to the tile manager the maximized tile belongs to. + * Used to get a reference to the tile manager the maximized tile belongs to. */ owner?: any; /** - * Used to get the jQuery element of the maximized tile + * Used to get the jQuery element of the maximized tile */ tile?: any; } @@ -69880,17 +69880,17 @@ interface TileMinimizingEvent { interface TileMinimizingEventUIParam { /** - * Used to get a reference to the tile manager performing the minimizing the tile belongs to. + * Used to get a reference to the tile manager performing the minimizing the tile belongs to. */ owner?: any; /** - * Used to get the jQuery element of the tile being minimized + * Used to get the jQuery element of the tile being minimized */ tile?: any; /** - * Used to get reference to the tile that is maximizing simultaneously or null if no tile is maximizing. + * Used to get reference to the tile that is maximizing simultaneously or null if no tile is maximizing. */ maximizingTile?: any; } @@ -69901,19 +69901,19 @@ interface TileMinimizedEvent { interface TileMinimizedEventUIParam { /** - * Used to get a reference to the tile manager the minimized tile belongs to. + * Used to get a reference to the tile manager the minimized tile belongs to. */ owner?: any; /** - * Used to get the jQuery element of the minimized tile + * Used to get the jQuery element of the minimized tile */ tile?: any; } interface IgTileManager { /** - * + * * * Valid values: * "string" The container width can be set in pixels (px) and percentage (%). @@ -69922,7 +69922,7 @@ interface IgTileManager { width?: string|number; /** - * Gets/Sets the height of the container. + * Gets/Sets the height of the container. * * * Valid values: @@ -69933,7 +69933,7 @@ interface IgTileManager { height?: string|number; /** - * Gets/Sets the width of each column in the container. + * Gets/Sets the width of each column in the container. * * * Valid values: @@ -69944,7 +69944,7 @@ interface IgTileManager { columnWidth?: string|number; /** - * Gets/Sets the height of each column in the container. + * Gets/Sets the height of each column in the container. * * * Valid values: @@ -69955,7 +69955,7 @@ interface IgTileManager { columnHeight?: string|number; /** - * Gets/Sets the columns count in the container. + * Gets/Sets the columns count in the container. * * * Valid values: @@ -69965,7 +69965,7 @@ interface IgTileManager { cols?: number; /** - * Gets/Sets the rows count in the container. + * Gets/Sets the rows count in the container. * * * Valid values: @@ -69975,27 +69975,27 @@ interface IgTileManager { rows?: number; /** - * Gets/Sets the horizontal spacing between tiles. + * Gets/Sets the horizontal spacing between tiles. * * number The horizontal spacing between tiles can be set as a number. */ marginLeft?: number; /** - * Gets/Sets the vertical spacing between tiles. + * Gets/Sets the vertical spacing between tiles. * * number The vertical spacing between tiles can be set as a number. */ marginTop?: number; /** - * Gets/Sets whether the items will rearrange when the container is resized. + * Gets/Sets whether the items will rearrange when the container is resized. * */ rearrangeItems?: boolean; /** - * Gets/Sets the tiles configurations. Every tile is described by rowSpan, colSpan, rowIndex and colIndex. + * Gets/Sets the tiles configurations. Every tile is described by rowSpan, colSpan, rowIndex and colIndex. * * * Valid values: @@ -70005,13 +70005,13 @@ interface IgTileManager { items?: Object; /** - * Specifies any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an [$.ig.DataSource](ig.datasource) itself. + * Specifies any valid data source accepted by [$.ig.DataSource](ig.datasource), or an instance of an [$.ig.DataSource](ig.datasource) itself. * */ dataSource?: any; /** - * Gets/Sets the content of the tiles in minimized state. + * Gets/Sets the content of the tiles in minimized state. * * * Valid values: @@ -70021,7 +70021,7 @@ interface IgTileManager { minimizedState?: string; /** - * Gets/Sets the content of the tiles in maximized state. + * Gets/Sets the content of the tiles in maximized state. * * * Valid values: @@ -70031,7 +70031,7 @@ interface IgTileManager { maximizedState?: string; /** - * Gets/Sets the index of which items configuration will be used for positioning and sizing of the maximized tile. + * Gets/Sets the index of which items configuration will be used for positioning and sizing of the maximized tile. * * * Valid values: @@ -70041,7 +70041,7 @@ interface IgTileManager { maximizedTileIndex?: number; /** - * Gets/Sets how many columns to be displayed in the right panel when the tiles are minimized. + * Gets/Sets how many columns to be displayed in the right panel when the tiles are minimized. * * * Valid values: @@ -70051,7 +70051,7 @@ interface IgTileManager { rightPanelCols?: number; /** - * Gets/Sets the width of the minimized tiles in the right panel. + * Gets/Sets the width of the minimized tiles in the right panel. * * * Valid values: @@ -70061,7 +70061,7 @@ interface IgTileManager { rightPanelTilesWidth?: number; /** - * Gets/Sets the height of the minimized tiles in the right panel. + * Gets/Sets the height of the minimized tiles in the right panel. * * * Valid values: @@ -70071,37 +70071,37 @@ interface IgTileManager { rightPanelTilesHeight?: number; /** - * Gets/Sets whether the right panel should show scrollbar when tiles are overflowing. + * Gets/Sets whether the right panel should show scrollbar when tiles are overflowing. * */ showRightPanelScroll?: boolean; /** - * Configure the container variable representation, which defines splitter functionality. + * Configure the container variable representation, which defines splitter functionality. * */ splitterOptions?: IgTileManagerSplitterOptions; /** - * Gets/Sets JQuery selector that specifies which elements will not trigger maximizing when clicked on. + * Gets/Sets JQuery selector that specifies which elements will not trigger maximizing when clicked on. * */ preventMaximizingSelector?: string; /** - * Gets/Sets the duration of the animations in the tile manager. + * Gets/Sets the duration of the animations in the tile manager. * */ animationDuration?: number; /** - * Specifies a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. + * Specifies a remote URL accepted by [$.ig.DataSource](ig.datasource) in order to request data from it. * */ dataSourceUrl?: string; /** - * Property in the response which specifies where the data records array will be held (if the response is wrapped). See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). + * Property in the response which specifies where the data records array will be held (if the response is wrapped). See [$.ig.DataSource responseDataKey](ig.datasource#options:settings.responseDataKey). * * * Valid values: @@ -70111,7 +70111,7 @@ interface IgTileManager { responseDataKey?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type) and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type) and its type property. * * * Valid values: @@ -70121,25 +70121,25 @@ interface IgTileManager { responseDataType?: string; /** - * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type) and its type property. + * Explicitly set data source type (such as "json"). Please refer to the documentation of [$.ig.DataSource type](ig.datasource#options:settings.type) and its type property. * */ dataSourceType?: string; /** - * Specifies the HTTP request method. + * Specifies the HTTP request method. * */ requestType?: string; /** - * Gets/Sets the HTTP content type for the response object. See [Perform an asynchronous HTTP (Ajax) request](http://api.jquery.com/jQuery.ajax/). + * Gets/Sets the HTTP content type for the response object. See [Perform an asynchronous HTTP (Ajax) request](http://api.jquery.com/jQuery.ajax/). * */ responseContentType?: string; /** - * Fired before databinding is performed + * Fired before databinding is performed * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. @@ -70148,7 +70148,7 @@ interface IgTileManager { dataBinding?: DataBindingEvent; /** - * Fired after databinding is complete + * Fired after databinding is complete * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. @@ -70159,7 +70159,7 @@ interface IgTileManager { dataBound?: DataBoundEvent; /** - * Fired before rendering of the tile manager begins. + * Fired before rendering of the tile manager begins. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. @@ -70169,7 +70169,7 @@ interface IgTileManager { rendering?: RenderingEvent; /** - * Fired after rendering of the tile manager completes. + * Fired after rendering of the tile manager completes. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. @@ -70177,7 +70177,7 @@ interface IgTileManager { rendered?: RenderedEvent; /** - * Event fired before a tile is rendered in the container + * Event fired before a tile is rendered in the container * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. @@ -70186,7 +70186,7 @@ interface IgTileManager { tileRendering?: TileRenderingEvent; /** - * Event Fired after a tile has been rendered in the container + * Event Fired after a tile has been rendered in the container * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. @@ -70195,7 +70195,7 @@ interface IgTileManager { tileRendered?: TileRenderedEvent; /** - * Fired before a tile in the tile manager is maximized. + * Fired before a tile in the tile manager is maximized. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. @@ -70205,7 +70205,7 @@ interface IgTileManager { tileMaximizing?: TileMaximizingEvent; /** - * Fired after a tile in the tile manager is maximized. + * Fired after a tile in the tile manager is maximized. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. @@ -70214,7 +70214,7 @@ interface IgTileManager { tileMaximized?: TileMaximizedEvent; /** - * Fired before a tile in the tile manager is minimized. + * Fired before a tile in the tile manager is minimized. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. @@ -70224,7 +70224,7 @@ interface IgTileManager { tileMinimizing?: TileMinimizingEvent; /** - * Fired after a tile in the tile manager is minimized. + * Fired after a tile in the tile manager is minimized. * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. @@ -70233,13 +70233,13 @@ interface IgTileManager { tileMinimized?: TileMinimizedEvent; /** - * Option for igTileManager + * Option for igTileManager */ [optionName: string]: any; } interface IgTileManagerMethods { /** - * Maximizes a given tile. + * Maximizes a given tile. * * @param $tileToMaximize Specifies the jQuery object of the tile element to be maximized. * @param animDuration Specifies the animation duration for this maximizing. @@ -70248,7 +70248,7 @@ interface IgTileManagerMethods { maximize($tileToMaximize: Object, animDuration?: number, event?: Object): void; /** - * Minimizes the maximized tile. Has no effect if no maximized tile is present. + * Minimizes the maximized tile. Has no effect if no maximized tile is present. * * @param animDuration Specifies the animation duration for this minimize. * @param event Indicates the browser even which triggered this action (not API). @@ -70256,31 +70256,31 @@ interface IgTileManagerMethods { minimize(animDuration?: number, event?: Object): void; /** - * Returns the maximized tile or null if such is not present. + * Returns the maximized tile or null if such is not present. * @return object|null Returns the maximized tile or null if such is not present. */ maximizedTile(): Object; /** - * Returns an array with the tiles in minimized state or null if such are not present. + * Returns an array with the tiles in minimized state or null if such are not present. * @return object|null Returns an array with the tiles in minimized state or null if such are not present. */ minimizedTiles(): Object; /** - * Returns the splitter associated with this tile manager or + * Returns the splitter associated with this tile manager or * null if the tile manager was instantiated with maximizedTileIndex. * @return object|null Returns the splitter associated with this tile manager or null if the tile manager was instantiated with maximizedTileIndex. */ splitter(): Object; /** - * Returns the [layout manager](ui.iglayoutmanager) associated with current tile manager. + * Returns the [layout manager](ui.iglayoutmanager) associated with current tile manager. */ layoutManager(): Object; /** - * Reflow the tile manager. Rearranging the tiles to fit in the container + * Reflow the tile manager. Rearranging the tiles to fit in the container * * @param forceReflow Indicates whether the reflow should be forced. Useful in cases where the items size and position was changed manually. * @param animationDuration The animation duration to be used for this reflow only. @@ -70289,17 +70289,17 @@ interface IgTileManagerMethods { reflow(forceReflow?: Object, animationDuration?: number, event?: Object): void; /** - * Returns the element that represents this widget. + * Returns the element that represents this widget. */ widget(): Object; /** - * Causes the TileManager to data bind to the data source (local or remote) , and re-render all of the data as well. + * Causes the TileManager to data bind to the data source (local or remote) , and re-render all of the data as well. */ dataBind(): void; /** - * Deletes the widget instance (client object). It is no longer accessible and all its event handlers stop working. Destroys all child widgets. Removes auto-generated HTML content, which is outside the widget, e.g. detached popups, dropdowns, etc. + * Deletes the widget instance (client object). It is no longer accessible and all its event handlers stop working. Destroys all child widgets. Removes auto-generated HTML content, which is outside the widget, e.g. detached popups, dropdowns, etc. */ destroy(): Object; } @@ -70977,158 +70977,158 @@ interface WindowResizedEventUIParam { interface IgToolbar { /** - * Set/Get the widget height. + * Set/Get the widget height. * */ height?: any; /** - * Set/Get the widget width. + * Set/Get the widget width. * */ width?: any; /** - * Get/Set whether the toolbar can be collapsed. + * Get/Set whether the toolbar can be collapsed. * */ allowCollapsing?: boolean; /** - * The css class that will be applied to collapseButtonIcon. + * The css class that will be applied to collapseButtonIcon. * */ collapseButtonIcon?: string; /** - * The css class that will be applied to the expand/collapse button icon. + * The css class that will be applied to the expand/collapse button icon. * */ expandButtonIcon?: string; /** - * Formal name of the widget. + * Formal name of the widget. * */ name?: string; /** - * Display Name of the widget. + * Display Name of the widget. * */ displayName?: string; /** - * Get/Set Toolbar's items. + * Get/Set Toolbar's items. * */ items?: any[]; /** - * Get/Set whether the widget is expanded initially. + * Get/Set whether the widget is expanded initially. * */ isExpanded?: boolean; /** - * Event fired after a click on any toolbar button + * Event fired after a click on any toolbar button */ toolbarButtonClick?: ToolbarButtonClickEvent; /** - * Event is fired before the toolbar is opened. + * Event is fired before the toolbar is opened. */ toolbarComboOpening?: ToolbarComboOpeningEvent; /** - * Event fired after toolbar combo is selected + * Event fired after toolbar combo is selected */ toolbarComboSelected?: ToolbarComboSelectedEvent; /** - * Event fired after a click on custom item + * Event fired after a click on custom item */ toolbarCustomItemClick?: ToolbarCustomItemClickEvent; /** - * Event fired after item is removed + * Event fired after item is removed */ itemRemoved?: ItemRemovedEvent; /** - * Event fired after item is added + * Event fired after item is added */ itemAdded?: ItemAddedEvent; /** - * Event is fired before item is collapsed. + * Event is fired before item is collapsed. */ collapsing?: CollapsingEvent; /** - * Event fired after item is collapsed + * Event fired after item is collapsed */ collapsed?: CollapsedEvent; /** - * Event fired before item is expanded + * Event fired before item is expanded */ expanding?: ExpandingEvent; /** - * Event fired after item is expanded + * Event fired after item is expanded */ expanded?: ExpandedEvent; /** - * Fired after item is dissabled + * Fired after item is dissabled */ itemDisable?: ItemDisableEvent; /** - * Fired after item is enabled + * Fired after item is enabled */ itemEnabled?: ItemEnabledEvent; /** - * Fired after the window is resized + * Fired after the window is resized */ windowResized?: WindowResizedEvent; /** - * Option for igToolbar + * Option for igToolbar */ [optionName: string]: any; } interface IgToolbarMethods { /** - * Returns the element on which the widget was instantiated + * Returns the element on which the widget was instantiated */ widget(): void; /** - * Gets the item by matching the provided index. + * Gets the item by matching the provided index. * * @param index The index of the item. */ getItem(index: Object): Object; /** - * Add item to widget item array + * Add item to widget item array * * @param item The item to be added. */ addItem(item: Object): void; /** - * Remove the item matching provided index. + * Remove the item matching provided index. * * @param index The index of the item. */ removeItem(index: Object): Object; /** - * Disable item matching provided index. + * Disable item matching provided index. * * @param index The index of the item. * @param disabled The disabled property value. @@ -71136,7 +71136,7 @@ interface IgToolbarMethods { disableItem(index: Object, disabled: Object): void; /** - * Activate item matching provided index. + * Activate item matching provided index. * * @param index The index of the item. * @param activated The activate property value. @@ -71144,12 +71144,12 @@ interface IgToolbarMethods { activateItem(index: Object, activated: Object): void; /** - * Deactivate all buttons. + * Deactivate all buttons. */ deactivateAll(): void; /** - * Destroy the widget. + * Destroy the widget. */ destroy(): void; } @@ -71460,7 +71460,7 @@ interface ActivatingEvent { interface ActivatingEventUIParam { /** - * Used to get reference to this igToolbarButton. + * Used to get reference to this igToolbarButton. */ owner?: any; } @@ -71471,7 +71471,7 @@ interface ActivatedEvent { interface ActivatedEventUIParam { /** - * Used to get reference to this igToolbarButton. + * Used to get reference to this igToolbarButton. */ owner?: any; } @@ -71482,7 +71482,7 @@ interface DeactivatingEvent { interface DeactivatingEventUIParam { /** - * Used to get reference to this igToolbarButton. + * Used to get reference to this igToolbarButton. */ owner?: any; } @@ -71493,84 +71493,84 @@ interface DeactivatedEvent { interface DeactivatedEventUIParam { /** - * Used to get reference to this igToolbarButton. + * Used to get reference to this igToolbarButton. */ owner?: any; } interface IgToolbarButton { /** - * Enable/Disable the "Toggling" of a button. + * Enable/Disable the "Toggling" of a button. * */ allowToggling?: boolean; /** - * Get/Set whether the toolbar button is selected. + * Get/Set whether the toolbar button is selected. * */ isSelected?: boolean; /** - * Event fired before the toolbar button is activated. + * Event fired before the toolbar button is activated. * Function takes arguments evt and ui. * Use ui.owner to get reference to this igToolbarButton. */ activating?: ActivatingEvent; /** - * Event fired after the toolbar button is activated. + * Event fired after the toolbar button is activated. * Function takes arguments evt and ui. * Use ui.owner to get reference to this igToolbarButton. */ activated?: ActivatedEvent; /** - * Event fired before the toolbar button is deactivated. + * Event fired before the toolbar button is deactivated. * Function takes arguments evt and ui. * Use ui.owner to get reference to this igToolbarButton. */ deactivating?: DeactivatingEvent; /** - * Event fired after the toolbar button is deactivated. + * Event fired after the toolbar button is deactivated. * Function takes arguments evt and ui. * Use ui.owner to get reference to this igToolbarButton. */ deactivated?: DeactivatedEvent; /** - * Option for igToolbarButton + * Option for igToolbarButton */ [optionName: string]: any; } interface IgToolbarButtonMethods { /** - * Toggle toolbar button + * Toggle toolbar button */ toggle(): void; /** - * Activate toolbar button + * Activate toolbar button * * @param event */ activate(event: Object): void; /** - * Deactivate toolbar button + * Deactivate toolbar button * * @param event */ deactivate(event: Object): void; /** - * Returns the element that represents this widget. + * Returns the element that represents this widget. */ widget(): Object; /** - * Destroy the widget. + * Destroy the widget. */ destroy(): void; } @@ -71684,7 +71684,7 @@ interface JQuery { } interface IgTreeGridColumnFixing { /** - * Option for igTreeGridColumnFixing + * Option for igTreeGridColumnFixing */ [optionName: string]: any; } @@ -71705,7 +71705,7 @@ interface JQuery { } interface IgTreeGridColumnMoving { /** - * Option for igTreeGridColumnMoving + * Option for igTreeGridColumnMoving */ [optionName: string]: any; } @@ -71726,31 +71726,31 @@ interface JQuery { } interface IgTreeGridFiltering { /** - * The property in the response that will hold the total number of records in the data source + * The property in the response that will hold the total number of records in the data source * */ recordCountKey?: string; /** - * Specifies from which data bound level to be applied filtering - 0 is the first level + * Specifies from which data bound level to be applied filtering - 0 is the first level * */ fromLevel?: number; /** - * Specifies to which data bound level to be applied filtering - if -1 filtering should be applied to the last data bound level + * Specifies to which data bound level to be applied filtering - if -1 filtering should be applied to the last data bound level * */ toLevel?: number; /** - * If displayMode is showWithAncestorsAndDescendants, show all records that match filtering conditions and their child records, even if child records don"t match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don"t match filtering conditions + * If displayMode is showWithAncestorsAndDescendants, show all records that match filtering conditions and their child records, even if child records don"t match filtering conditions. If displayMode is showWithAncestors show only those records that match filtering conditions and do not show child records(if any) that don"t match filtering conditions * */ displayMode?: any; /** - * Specifies the name of a boolean property in the dataRecord object that indicates whether the dataRow matches the filtering conditions. + * Specifies the name of a boolean property in the dataRecord object that indicates whether the dataRow matches the filtering conditions. * When filtering a boolean flag with the specified name is added on each data record object with a value of true if it matches the condition or false if it doesn"t. * This is used mainly for internal purposes. * @@ -71758,7 +71758,7 @@ interface IgTreeGridFiltering { matchFiltering?: string; /** - * Template that is used when filtering is applied and paging is enabled and user goes to another page. It takes precedence over the pagerRecordsLabelTemplate(option from igTreeGridPaging). If it is set to null then it is taken option from igTreeGridPaging. + * Template that is used when filtering is applied and paging is enabled and user goes to another page. It takes precedence over the pagerRecordsLabelTemplate(option from igTreeGridPaging). If it is set to null then it is taken option from igTreeGridPaging. * Supported options: * ${currentPageMatches} (filtering) * ${totalMatches} (filtering) @@ -71769,13 +71769,13 @@ interface IgTreeGridFiltering { filterSummaryInPagerTemplate?: string; /** - * Option for igTreeGridFiltering + * Option for igTreeGridFiltering */ [optionName: string]: any; } interface IgTreeGridFilteringMethods { /** - * Returns the count of data records that match filtering conditions + * Returns the count of data records that match filtering conditions */ getFilteringMatchesCount(): number; destroy(): void; @@ -71893,19 +71893,19 @@ interface JQuery { } interface IgTreeGridHiding { /** - * A list of column settings that specifies hiding options on a per column basis. + * A list of column settings that specifies hiding options on a per column basis. * */ columnSettings?: IgGridHidingColumnSetting[]; /** - * The width in pixels of the hidden column indicator in the header. + * The width in pixels of the hidden column indicator in the header. * */ hiddenColumnIndicatorHeaderWidth?: number; /** - * Controls containment behavior. + * Controls containment behavior. * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area @@ -71913,103 +71913,103 @@ interface IgTreeGridHiding { columnChooserContainment?: string; /** - * The default column chooser width. + * The default column chooser width. * */ columnChooserWidth?: string; /** - * The default column chooser height. + * The default column chooser height. * */ columnChooserHeight?: string; /** - * The duration of the dropdown animation in milliseconds. + * The duration of the dropdown animation in milliseconds. * */ dropDownAnimationDuration?: number; /** - * The caption of the column chooser dialog. + * The caption of the column chooser dialog. * */ columnChooserCaptionText?: string; /** - * The text used in the drop down tools menu(Feature Chooser) to launch the column chooser dialog. + * The text used in the drop down tools menu(Feature Chooser) to launch the column chooser dialog. * */ columnChooserDisplayText?: string; /** - * The text displayed in the tooltip of the hidden column indicator. + * The text displayed in the tooltip of the hidden column indicator. * */ hiddenColumnIndicatorTooltipText?: string; /** - * The text used in the drop down tools menu(Feature Chooser) to hide a column. + * The text used in the drop down tools menu(Feature Chooser) to hide a column. * */ columnHideText?: string; /** - * The text used in the column chooser to show column + * The text used in the column chooser to show column * */ columnChooserShowText?: string; /** - * The text used in the column chooser to hide column + * The text used in the column chooser to hide column * */ columnChooserHideText?: string; /** - * Specifies on click show/hide directly to be shown/hidden columns. If columnChooserHideOnClick is false then Apply and Cancel Buttons are shown on the bottom of modal dialog. Columns are Shown/Hidden after the Apply button is clicked + * Specifies on click show/hide directly to be shown/hidden columns. If columnChooserHideOnClick is false then Apply and Cancel Buttons are shown on the bottom of modal dialog. Columns are Shown/Hidden after the Apply button is clicked * */ columnChooserHideOnClick?: boolean; /** - * Text label for reset button. + * Text label for reset button. * */ columnChooserResetButtonLabel?: string; /** - * Specifies time of milliseconds for animation duration to show/hide modal dialog + * Specifies time of milliseconds for animation duration to show/hide modal dialog * */ columnChooserAnimationDuration?: number; /** - * Specifies text of button which apply changes in modal dialog + * Specifies text of button which apply changes in modal dialog * */ columnChooserButtonApplyText?: string; /** - * Specifies text of button which cancel changes in modal dialog + * Specifies text of button which cancel changes in modal dialog * */ columnChooserButtonCancelText?: string; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before a hiding operation is executed. + * Event fired before a hiding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72019,7 +72019,7 @@ interface IgTreeGridHiding { columnHiding?: ColumnHidingEvent; /** - * Event fired when trying to hide all columns in fixed or unfixed area. + * Event fired when trying to hide all columns in fixed or unfixed area. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72028,7 +72028,7 @@ interface IgTreeGridHiding { columnHidingRefused?: ColumnHidingRefusedEvent; /** - * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. + * Event fired when trying to show column(s) in fixed area and total width of fixed are will be larger than whole grid width. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72037,7 +72037,7 @@ interface IgTreeGridHiding { columnShowingRefused?: ColumnShowingRefusedEvent; /** - * Event fired before a hiding operation is executed. + * Event fired before a hiding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72046,7 +72046,7 @@ interface IgTreeGridHiding { multiColumnHiding?: MultiColumnHidingEvent; /** - * Event fired after the hiding has been executed and results are rendered. + * Event fired after the hiding has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72056,7 +72056,7 @@ interface IgTreeGridHiding { columnHidden?: ColumnHiddenEvent; /** - * Event fired before a showing operation is executed. + * Event fired before a showing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72066,7 +72066,7 @@ interface IgTreeGridHiding { columnShowing?: ColumnShowingEvent; /** - * Event fired after the showing has been executed and results are rendered. + * Event fired after the showing has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72076,7 +72076,7 @@ interface IgTreeGridHiding { columnShown?: ColumnShownEvent; /** - * Event fired before the column chooser is opened. + * Event fired before the column chooser is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72085,7 +72085,7 @@ interface IgTreeGridHiding { columnChooserOpening?: ColumnChooserOpeningEvent; /** - * Event fired after the column chooser is already opened. + * Event fired after the column chooser is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72094,7 +72094,7 @@ interface IgTreeGridHiding { columnChooserOpened?: ColumnChooserOpenedEvent; /** - * Event fired every time the column chooser changes its position. + * Event fired every time the column chooser changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72105,7 +72105,7 @@ interface IgTreeGridHiding { columnChooserMoving?: ColumnChooserMovingEvent; /** - * Event fired before the column chooser is closed. + * Event fired before the column chooser is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72114,7 +72114,7 @@ interface IgTreeGridHiding { columnChooserClosing?: ColumnChooserClosingEvent; /** - * Event fired after the column chooser has been closed. + * Event fired after the column chooser has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72123,7 +72123,7 @@ interface IgTreeGridHiding { columnChooserClosed?: ColumnChooserClosedEvent; /** - * Event fired before the contents of the column chooser are rendered. + * Event fired before the contents of the column chooser are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72132,7 +72132,7 @@ interface IgTreeGridHiding { columnChooserContentsRendering?: ColumnChooserContentsRenderingEvent; /** - * Event fired after the contents of the column chooser are rendered. + * Event fired after the contents of the column chooser are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72141,7 +72141,7 @@ interface IgTreeGridHiding { columnChooserContentsRendered?: ColumnChooserContentsRenderedEvent; /** - * Event fired when button Apply in column chooser is clicked + * Event fired when button Apply in column chooser is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72152,7 +72152,7 @@ interface IgTreeGridHiding { columnChooserButtonApplyClick?: ColumnChooserButtonApplyClickEvent; /** - * Event fired when button Reset in column chooser is clicked + * Event fired when button Reset in column chooser is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridHiding widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -72161,7 +72161,7 @@ interface IgTreeGridHiding { columnChooserButtonResetClick?: ColumnChooserButtonResetClickEvent; /** - * Option for igTreeGridHiding + * Option for igTreeGridHiding */ [optionName: string]: any; } @@ -72169,18 +72169,18 @@ interface IgTreeGridHidingMethods { destroy(): void; /** - * Shows the Column Chooser dialog. If it is visible the method does nothing. + * Shows the Column Chooser dialog. If it is visible the method does nothing. */ showColumnChooser(): void; /** - * Hides the Column Chooser dialog. If it is not visible the method does nothing. + * Hides the Column Chooser dialog. If it is not visible the method does nothing. */ hideColumnChooser(): void; /** - * Shows a hidden column. If the column is not hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Shows a hidden column. If the column is not hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. @@ -72189,8 +72189,8 @@ interface IgTreeGridHidingMethods { showColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; /** - * Hides a visible column. If the column is hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Hides a visible column. If the column is hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. An identifier for the column should be of type string. @@ -72199,8 +72199,8 @@ interface IgTreeGridHidingMethods { hideColumn(column: Object, isMultiColumnHeader?: boolean, callback?: Function): void; /** - * Hides visible columns specified by the array. If the column is hidden the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Hides visible columns specified by the array. If the column is hidden the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are hidden(optional) @@ -72208,8 +72208,8 @@ interface IgTreeGridHidingMethods { hideMultiColumns(columns: any[], callback?: Function): void; /** - * Show visible columns specified by the array. If the column is shown the method does nothing. - * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. + * Show visible columns specified by the array. If the column is shown the method does nothing. + * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are shown(optional) @@ -72217,22 +72217,22 @@ interface IgTreeGridHidingMethods { showMultiColumns(columns: any[], callback?: Function): void; /** - * Gets whether the reset button in the column chooser dialog is to be rendered or not. + * Gets whether the reset button in the column chooser dialog is to be rendered or not. */ isToRenderButtonReset(): void; /** - * Reset hidden/shown column to initial state of dialog(when it is opened) + * Reset hidden/shown column to initial state of dialog(when it is opened) */ resetHidingColumnChooser(): void; /** - * Renders the Reset button in the Column Chooser dialog. + * Renders the Reset button in the Column Chooser dialog. */ renderColumnChooserResetButton(): void; /** - * Remove Reset button in column chooser modal dialog + * Remove Reset button in column chooser modal dialog */ removeColumnChooserResetButton(): void; } @@ -72866,116 +72866,116 @@ interface JQuery { } interface IgTreeGridDataSourceSettings { /** - * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. + * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. * */ propertyExpanded?: string; /** - * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. + * The name of the property that keeps track of the level in the hierarchy.Defaults to __ig_options.dataLevel. * */ propertyDataLevel?: string; /** - * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) + * If set to TRUE it is expected that the source of data is normalized and transformed(has set dataLevel and expansion state). The source of data is used as flatDataView. Usually used when the paging is remote and paging mode is allLevels, or features are remote(and the processing of the returned result should be made on the server) * */ initialFlatDataView?: boolean; /** - * Option for IgTreeGridDataSourceSettings + * Option for IgTreeGridDataSourceSettings */ [optionName: string]: any; } interface IgTreeGrid { /** - * Specifies the indentation (in pixels or percent) for a tree grid row. Nested indentation is achieved by calculating the level times the indentation value. Ex: '10px' or '5%'. Default is 30. + * Specifies the indentation (in pixels or percent) for a tree grid row. Nested indentation is achieved by calculating the level times the indentation value. Ex: '10px' or '5%'. Default is 30. * */ indentation?: string; /** - * If initial indentation level is set then it is used to be calculated width of the data skip column(usually used when remote load on demand is enabled) + * If initial indentation level is set then it is used to be calculated width of the data skip column(usually used when remote load on demand is enabled) * */ initialIndentationLevel?: number; /** - * Specifies if rows(that have child rows) will have an expander image that will allow end users to expand and collapse them. This option can be set only at initialization. + * Specifies if rows(that have child rows) will have an expander image that will allow end users to expand and collapse them. This option can be set only at initialization. * */ showExpansionIndicator?: boolean; /** - * Specifies the expansion indicator tooltip text. + * Specifies the expansion indicator tooltip text. * */ expandTooltipText?: string; /** - * Specifies the collapse indicator tooltip text. + * Specifies the collapse indicator tooltip text. * */ collapseTooltipText?: string; /** - * Unique identifier used in a self-referencing flat data source. Used with primaryKey to create a relationship among flat data sources. + * Unique identifier used in a self-referencing flat data source. Used with primaryKey to create a relationship among flat data sources. * */ foreignKey?: string; /** - * Specifies the depth down to which the tree grid would be expanded upon initial render. To expand all rows set value to -1. Default is -1. + * Specifies the depth down to which the tree grid would be expanded upon initial render. To expand all rows set value to -1. Default is -1. * */ initialExpandDepth?: number; /** - * Specifies the foreign key value in the data source to treat as the root level once the grid is data bound. Defaults to -1 (which includes the entire data source) + * Specifies the foreign key value in the data source to treat as the root level once the grid is data bound. Defaults to -1 (which includes the entire data source) * */ foreignKeyRootValue?: number; /** - * Specify whether to render non-data column which contains expander indicators + * Specify whether to render non-data column which contains expander indicators * */ renderExpansionIndicatorColumn?: boolean; /** - * a reference or name of a javascript function which changes first data cell - renders indentation according to databound level + * a reference or name of a javascript function which changes first data cell - renders indentation according to databound level * */ renderFirstDataCellFunction?: string|Object; /** - * Property name of the array of child data in a hierarchical data source. + * Property name of the array of child data in a hierarchical data source. * */ childDataKey?: string; /** - * a reference or name of a javascript function which renders expand indicators(called ONLY IF option renderExpansionIndicatorColumn is true) + * a reference or name of a javascript function which renders expand indicators(called ONLY IF option renderExpansionIndicatorColumn is true) * */ renderExpansionCellFunction?: string|Object; /** - * Specifies to the tree grid if data is loaded on demand from a remote server. Default is false. + * Specifies to the tree grid if data is loaded on demand from a remote server. Default is false. * */ enableRemoteLoadOnDemand?: boolean; /** - * Options object to configure data source-specific settings + * Options object to configure data source-specific settings * */ dataSourceSettings?: IgTreeGridDataSourceSettings; /** - * Fired when a row is about to be expanded. + * Fired when a row is about to be expanded. * use args.owner to access the instance of the igTreeGrid * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. @@ -72984,7 +72984,7 @@ interface IgTreeGrid { rowExpanding?: RowExpandingEvent; /** - * Fired when a row is expanded. + * Fired when a row is expanded. * use args.owner to access the instance of the igTreeGrid * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. @@ -72994,7 +72994,7 @@ interface IgTreeGrid { rowExpanded?: RowExpandedEvent; /** - * Fired when a row is about to be collapsed. + * Fired when a row is about to be collapsed. * use args.owner to access the instance of the igTreeGrid * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. @@ -73003,7 +73003,7 @@ interface IgTreeGrid { rowCollapsing?: RowCollapsingEvent; /** - * Fired after a row is collapsed + * Fired after a row is collapsed * use args.owner to access the instance of the igTreeGrid * use args.row to access the row element (as a wrapped jQuery object) that is about to be expanded * use args.fixedRow to access the row element (as a jQuery wrapped object) in a fixed column that is about to expanded. If there are no fixed columns then this property returns undefined. @@ -73013,13 +73013,13 @@ interface IgTreeGrid { rowCollapsed?: RowCollapsedEvent; /** - * Option for igTreeGrid + * Option for igTreeGrid */ [optionName: string]: any; } interface IgTreeGridMethods { /** - * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. + * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * * @param rowId If specified, will only rollback the transactions with that row id. * @param updateUI Whether to update the UI or not. @@ -73027,12 +73027,12 @@ interface IgTreeGridMethods { rollback(rowId?: Object, updateUI?: boolean): any[]; /** - * Causes the treegrid to data bind to the data source (local or remote) , and re-render all of the data + * Causes the treegrid to data bind to the data source (local or remote) , and re-render all of the data */ dataBind(): void; /** - * Toggle row by specified row or row identifier + * Toggle row by specified row or row identifier * * @param row jQuery table row object or a row id. * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded @@ -73040,7 +73040,7 @@ interface IgTreeGridMethods { toggleRow(row: Object, callback?: Function): void; /** - * Expands a parent row by specified row or row identifier + * Expands a parent row by specified row or row identifier * * @param row jQuery table row object or a row id. * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded @@ -73048,7 +73048,7 @@ interface IgTreeGridMethods { expandRow(row: Object, callback?: Function): void; /** - * Collapses a parent row by specified row or row identifier + * Collapses a parent row by specified row or row identifier * * @param row jQuery table row object, raw DOM row object or a row id. * @param callback Specifies a custom function to be called when row is expanded/collapsed. The callback has 4 arguments- a reference to the current context(this), object that holds 2 properties(unfixedRow - DOM representation of the unfixed row, fixedRow - DOM representation of the fixed row, if there is no fixed columns it is undefined), reference to the dataRecord, expand - specifies whether row is expanded @@ -73056,7 +73056,7 @@ interface IgTreeGridMethods { collapseRow(row: Object, callback?: Function): void; /** - * Adds a new row (TR) to the grid as a child of a specific row, by taking a data row object. Assumes the record will have the primary key. + * Adds a new row (TR) to the grid as a child of a specific row, by taking a data row object. Assumes the record will have the primary key. * * @param rec The data row JavaScript object. * @param parentId Identifier/key of the targeted parent row. If missing, then the new row is rendered to the bottom of the grid. @@ -73064,7 +73064,7 @@ interface IgTreeGridMethods { renderNewChild(rec: Object, parentId?: string): void; /** - * Destroys igTreeGrid + * Destroys igTreeGrid */ destroy(): Object; } @@ -73368,12 +73368,12 @@ interface JQuery { } interface IgTreeGridMultiColumnHeaders { /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before a group collapsing operation is executed. + * Event fired before a group collapsing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -73383,7 +73383,7 @@ interface IgTreeGridMultiColumnHeaders { groupCollapsing?: GroupCollapsingEvent; /** - * Event fired after the group collapsing has been executed and results are rendered. + * Event fired after the group collapsing has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -73393,7 +73393,7 @@ interface IgTreeGridMultiColumnHeaders { groupCollapsed?: GroupCollapsedEvent; /** - * Event fired before a group expanding operation is executed. + * Event fired before a group expanding operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -73403,7 +73403,7 @@ interface IgTreeGridMultiColumnHeaders { groupExpanding?: GroupExpandingEvent; /** - * Event fired after the group expanding has been executed and results are rendered. + * Event fired after the group expanding has been executed and results are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridMultiColumnHeaders widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -73413,7 +73413,7 @@ interface IgTreeGridMultiColumnHeaders { groupExpanded?: GroupExpandedEvent; /** - * Option for igTreeGridMultiColumnHeaders + * Option for igTreeGridMultiColumnHeaders */ [optionName: string]: any; } @@ -73421,7 +73421,7 @@ interface IgTreeGridMultiColumnHeadersMethods { destroy(): void; /** - * Expands a collapsed group. If the group is expanded, the method does nothing. + * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -73430,7 +73430,7 @@ interface IgTreeGridMultiColumnHeadersMethods { expandGroup(groupKey: string, callback?: Function): void; /** - * Collapses an expanded group. If the group is collapsed, the method does nothing. + * Collapses an expanded group. If the group is collapsed, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -73439,7 +73439,7 @@ interface IgTreeGridMultiColumnHeadersMethods { collapseGroup(groupKey: string, callback?: Function): void; /** - * Toggles a collapsible group. + * Toggles a collapsible group. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param groupKey Group key. @@ -73448,7 +73448,7 @@ interface IgTreeGridMultiColumnHeadersMethods { toggleGroup(groupKey: string, callback?: Function): void; /** - * Returns multicolumn headers array. if there aren"t multicolumn headers returns undefined + * Returns multicolumn headers array. if there aren"t multicolumn headers returns undefined */ getMultiColumnHeaders(): any[]; } @@ -73574,22 +73574,22 @@ interface ContextRowRenderingEvent { interface ContextRowRenderingEventUIParam { /** - * Used to get reference to igTreeGridPaging. + * Used to get reference to igTreeGridPaging. */ owner?: any; /** - * Used to get reference to the first data row. Null if there are no records. + * Used to get reference to the first data row. Null if there are no records. */ dataRow?: any; /** - * Used to get current page index. + * Used to get current page index. */ currentPageIndex?: any; /** - * Used to get the current context row mode. + * Used to get the current context row mode. */ contextRowMode?: any; } @@ -73600,34 +73600,34 @@ interface ContextRowRenderedEvent { interface ContextRowRenderedEventUIParam { /** - * Used to get reference to igTreeGridPaging. + * Used to get reference to igTreeGridPaging. */ owner?: any; /** - * Used to get reference to the first data row. Null if there are no records. + * Used to get reference to the first data row. Null if there are no records. */ dataRow?: any; /** - * Used to get current page index. + * Used to get current page index. */ currentPageIndex?: any; /** - * Used to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow + * Used to get array of the parent rows(of the ui.dataRow). If the dataRow is null(for instance filter is applied and no records are shown) then it is empty array. Otherwise it contains all ancestors ordered by level(including the current dataRow) - the first item is root level, the last array item is the current ui.dataRow */ parentRows?: any; /** - * Used to get the current context row mode. + * Used to get the current context row mode. */ contextRowMode?: any; } interface IgTreeGridPaging { /** - * Sets gets paging mode. + * Sets gets paging mode. * * * Valid values: @@ -73637,7 +73637,7 @@ interface IgTreeGridPaging { mode?: string; /** - * When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row. When mode option is "rootLevelOnly" then the context row always shows the value of the contextRowRootText option. + * When data flows to the next page there are a couple of different modes that can help communicate the context of a leaf level row. When mode option is "rootLevelOnly" then the context row always shows the value of the contextRowRootText option. * * * Valid values: @@ -73648,67 +73648,67 @@ interface IgTreeGridPaging { contextRowMode?: string; /** - * Sets/gets the text message shown while loading content of the context row(while processing breadcrumb/immediate parent row). It is set via $.html(). If set to null loading message is not shown. + * Sets/gets the text message shown while loading content of the context row(while processing breadcrumb/immediate parent row). It is set via $.html(). If set to null loading message is not shown. * */ contextRowLoadingText?: string; /** - * Sets/gets the content of the context row when the first record in the page is root(hasn't ancestors) record. It is set via $.html() + * Sets/gets the content of the context row when the first record in the page is root(hasn't ancestors) record. It is set via $.html() * */ contextRowRootText?: string; /** - * Sets/gets the column key of ancestor to be shown in the breadcrumb trail. It is used only when contextRowMode is breadcrumb + * Sets/gets the column key of ancestor to be shown in the breadcrumb trail. It is used only when contextRowMode is breadcrumb * */ breadcrumbKey?: string; /** - * Sets/gets (it is set via $.html()) delimiter between ancestors in the breadcrumb trail. It is used only when contextRowMode is breadcrumb + * Sets/gets (it is set via $.html()) delimiter between ancestors in the breadcrumb trail. It is used only when contextRowMode is breadcrumb * */ breadcrumbDelimiter?: string; /** - * Reference to the (or name of )function, called before rendering context row content(rendering loading message/bread crumb/parent row). The function takes 4 arguments- dataRow, $textArea- jQuery representation of the text area of the context row(when mode is loading/breadcrumb then it is otherwise ), array of parent rows and context mode - "loading"|"breadcrumb"|"parent". When the function returns string it is used as html set in $textArea. If the function does not return result or returns false/empty string then rendering of the content of the context row should be handled by the developer(similar to canceling rendering of context row content). + * Reference to the (or name of )function, called before rendering context row content(rendering loading message/bread crumb/parent row). The function takes 4 arguments- dataRow, $textArea- jQuery representation of the text area of the context row(when mode is loading/breadcrumb then it is otherwise ), array of parent rows and context mode - "loading"|"breadcrumb"|"parent". When the function returns string it is used as html set in $textArea. If the function does not return result or returns false/empty string then rendering of the content of the context row should be handled by the developer(similar to canceling rendering of context row content). * */ renderContextRowFunc?: Function|string; /** - * Number of records loaded and displayed per page. + * Number of records loaded and displayed per page. * */ pageSize?: number; /** - * The property in the response data, when using remote data source, that will hold the total number of records in the data source. + * The property in the response data, when using remote data source, that will hold the total number of records in the data source. * */ recordCountKey?: string; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page size. + * Denotes the name of the encoded URL parameter that will state what is the currently requested page size. * */ pageSizeUrlKey?: string; /** - * Denotes the name of the encoded URL parameter that will state what is the currently requested page index. + * Denotes the name of the encoded URL parameter that will state what is the currently requested page index. * */ pageIndexUrlKey?: string; /** - * Current page index that's bound in the data source and rendered in the UI. + * Current page index that's bound in the data source and rendered in the UI. * */ currentPageIndex?: number; /** - * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). + * Type of paging. Delegates all paging functionality to the [$.ig.DataSource](ig.datasource). * * * Valid values: @@ -73718,25 +73718,25 @@ interface IgTreeGridPaging { type?: string; /** - * If false, a dropdown allowing to change the page size will not be rendered in the UI. + * If false, a dropdown allowing to change the page size will not be rendered in the UI. * */ showPageSizeDropDown?: boolean; /** - * Text rendered in front of the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. + * Text rendered in front of the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. * */ pageSizeDropDownLabel?: string; /** - * Trailing text for the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. + * Trailing text for the page size dropdown, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. * */ pageSizeDropDownTrailingLabel?: string; /** - * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. + * Page size dropdown location, when [showPageSizeDropDown](ui.iggridpaging#options:showPageSizeDropDown) is set to true. Can be rendered above the grid header or inside the pager, next to the page links. * * * Valid values: @@ -73746,157 +73746,157 @@ interface IgTreeGridPaging { pageSizeDropDownLocation?: string; /** - * Option specifying whether to show summary label for the currently rendered records or not. + * Option specifying whether to show summary label for the currently rendered records or not. * */ showPagerRecordsLabel?: boolean; /** - * Custom pager records label template - in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. + * Custom pager records label template - in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. * */ pagerRecordsLabelTemplate?: string; /** - * Text for the next page label. + * Text for the next page label. * */ nextPageLabelText?: string; /** - * Text for the previous page label. + * Text for the previous page label. * */ prevPageLabelText?: string; /** - * Text for the first page label. + * Text for the first page label. * */ firstPageLabelText?: string; /** - * Text for the last page label. + * Text for the last page label. * */ lastPageLabelText?: string; /** - * Option specifying whether to render the first and last page navigation buttons. + * Option specifying whether to render the first and last page navigation buttons. * */ showFirstLastPages?: boolean; /** - * Option specifying whether to render the previous and next page navigation buttons. + * Option specifying whether to render the previous and next page navigation buttons. * */ showPrevNextPages?: boolean; /** - * Leading label text for the drop down from where the page index can be switched. + * Leading label text for the drop down from where the page index can be switched. * */ currentPageDropDownLeadingLabel?: string; /** - * Trailing label text for the drop down from where the page index can be switched. + * Trailing label text for the drop down from where the page index can be switched. * */ currentPageDropDownTrailingLabel?: string; /** - * Tooltip text for the page index drop down. + * Tooltip text for the page index drop down. * */ currentPageDropDownTooltip?: string; /** - * Tooltip text for the page size drop down. + * Tooltip text for the page size drop down. * */ pageSizeDropDownTooltip?: string; /** - * Tooltip text for the pager records label. + * Tooltip text for the pager records label. * */ pagerRecordsLabelTooltip?: string; /** - * Tooltip text for the previous page button. + * Tooltip text for the previous page button. * */ prevPageTooltip?: string; /** - * Tooltip text for the next page button. + * Tooltip text for the next page button. * */ nextPageTooltip?: string; /** - * Tooltip text for the first page button. + * Tooltip text for the first page button. * */ firstPageTooltip?: string; /** - * Tooltip text for the last page button. + * Tooltip text for the last page button. * */ lastPageTooltip?: string; /** - * Tooltip text templates of buttons that navigate to a particular page. The format string follows the [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. See also the [pageCountLimit](ui.iggridpaging#options:pageCountLimit) option. + * Tooltip text templates of buttons that navigate to a particular page. The format string follows the [igTemplating](http://www.igniteui.com/help/igtemplating-overview) style and syntax. See also the [pageCountLimit](ui.iggridpaging#options:pageCountLimit) option. * */ pageTooltipFormat?: string; /** - * Predefined page sizes that are available to the end user to switch their grid paging to, through a drop down in the grid header. + * Predefined page sizes that are available to the end user to switch their grid paging to, through a drop down in the grid header. * */ pageSizeList?: any; /** - * Sets/Gets the number of pages which if exceeded a drop down list of page indices is displayed. If the number of pages is less than or equal to this option then buttons for each page are displayed. + * Sets/Gets the number of pages which if exceeded a drop down list of page indices is displayed. If the number of pages is less than or equal to this option then buttons for each page are displayed. * */ pageCountLimit?: number; /** - * Number of page buttons, adjacent to and including the [active page](ui.iggridpaging#options:currentPageIndex), that are constantly visible. For the invisible pages, previous and next buttons are used. + * Number of page buttons, adjacent to and including the [active page](ui.iggridpaging#options:currentPageIndex), that are constantly visible. For the invisible pages, previous and next buttons are used. * */ visiblePageCount?: number; /** - * Drop down width for the page size and page index drop downs. + * Drop down width for the page size and page index drop downs. * */ defaultDropDownWidth?: number; /** - * Time in milliseconds for which page drop down will wait for keystrokes before changing the page. + * Time in milliseconds for which page drop down will wait for keystrokes before changing the page. * */ delayOnPageChanged?: number; /** - * Enables/disables paging persistence between states. + * Enables/disables paging persistence between states. * */ persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before rendering context row content. + * Event fired before rendering context row content. * Return false in order to cancel this event. * Function takes arguments evt and ui. * Use ui.owner to get reference to igTreeGridPaging. @@ -73907,7 +73907,7 @@ interface IgTreeGridPaging { contextRowRendering?: ContextRowRenderingEvent; /** - * Event fired context row content is rendered. + * Event fired context row content is rendered. * Function takes arguments evt and ui. * Use ui.owner to get reference to igTreeGridPaging. * Use ui.dataRow to get reference to the first data row. Null if there are no records. @@ -73918,7 +73918,7 @@ interface IgTreeGridPaging { contextRowRendered?: ContextRowRenderedEvent; /** - * Event fired before the page index is changed. + * Event fired before the page index is changed. * Return false in order to cancel page index changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -73929,7 +73929,7 @@ interface IgTreeGridPaging { pageIndexChanging?: PageIndexChangingEvent; /** - * Event fired after the page index is changed , but before grid data rebinds + * Event fired after the page index is changed , but before grid data rebinds * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -73938,7 +73938,7 @@ interface IgTreeGridPaging { pageIndexChanged?: PageIndexChangedEvent; /** - * Event fired when the page size is about to be changed from the page size dropdown. + * Event fired when the page size is about to be changed from the page size dropdown. * Return false in order to cancel page size changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -73949,7 +73949,7 @@ interface IgTreeGridPaging { pageSizeChanging?: PageSizeChangingEvent; /** - * Event fired after the page size is changed from the page size dropdown. + * Event fired after the page size is changed from the page size dropdown. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -73958,7 +73958,7 @@ interface IgTreeGridPaging { pageSizeChanged?: PageSizeChangedEvent; /** - * Event fired before the pager footer is rendered (the whole area below the grid records). + * Event fired before the pager footer is rendered (the whole area below the grid records). * Return false in order to cancel pager footer rendering. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. @@ -73968,7 +73968,7 @@ interface IgTreeGridPaging { pagerRendering?: PagerRenderingEvent; /** - * Event fired after the pager footer is rendered + * Event fired after the pager footer is rendered * Function takes arguments evt and ui. * Use ui.owner to get reference to GridPaging. * Use ui.owner.grid to get reference to the grid. @@ -73977,35 +73977,35 @@ interface IgTreeGridPaging { pagerRendered?: PagerRenderedEvent; /** - * Option for igTreeGridPaging + * Option for igTreeGridPaging */ [optionName: string]: any; } interface IgTreeGridPagingMethods { /** - * Destroys the igTreeGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging + * Destroys the igTreeGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging */ destroy(): void; /** - * Get jQuery representation of of the context row. It is rendered in the header. If there isn't such element - creates it. + * Get jQuery representation of of the context row. It is rendered in the header. If there isn't such element - creates it. */ getContextRow(): Object; /** - * Get jQuery representation of element that holds text area of the context row. If there isn't such element - creates it. + * Get jQuery representation of element that holds text area of the context row. If there isn't such element - creates it. */ getContextRowTextArea(): Object; /** - * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). + * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * * @param index The page index to go to. */ pageIndex(index?: number): number; /** - * Gets/Sets the page size. If no parameter is specified, just returns the current page size. + * Gets/Sets the page size. If no parameter is specified, just returns the current page size. * * @param size The new page size. */ @@ -74795,36 +74795,36 @@ interface JQuery { } interface IgTreeGridResizing { /** - * Resize the column to the size of the longest currently visible cell value. + * Resize the column to the size of the longest currently visible cell value. * */ allowDoubleClickToResize?: boolean; /** - * Specifies whether the resizing should be deferred until the user finishes resizing or applied immediately. + * Specifies whether the resizing should be deferred until the user finishes resizing or applied immediately. * */ deferredResizing?: boolean; /** - * A list of column settings that specifies resizing options on a per column basis. + * A list of column settings that specifies resizing options on a per column basis. * */ columnSettings?: IgGridResizingColumnSetting[]; /** - * The width in pixels of the resizing handle which is position at the right side of each resizeable column header. + * The width in pixels of the resizing handle which is position at the right side of each resizeable column header. * */ handleThreshold?: number; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before a resizing operation is executed. + * Event fired before a resizing operation is executed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -74835,7 +74835,7 @@ interface IgTreeGridResizing { columnResizing?: ColumnResizingEvent; /** - * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) + * Event fired(only when columnFixing is enabled) when trying to resize column in fixed area so total width of unfixed area to be less than minimalVisibleAreaWidth(option defined in columnFixing) * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -74846,7 +74846,7 @@ interface IgTreeGridResizing { columnResizingRefused?: ColumnResizingRefusedEvent; /** - * Event fired after the resizing has been executed and results are rendered + * Event fired after the resizing has been executed and results are rendered * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridResizing widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -74858,7 +74858,7 @@ interface IgTreeGridResizing { columnResized?: ColumnResizedEvent; /** - * Option for igTreeGridResizing + * Option for igTreeGridResizing */ [optionName: string]: any; } @@ -74866,7 +74866,7 @@ interface IgTreeGridResizingMethods { destroy(): void; /** - * Resizes a column to a specified width in pixels, percents or auto if no width is specified. + * Resizes a column to a specified width in pixels, percents or auto if no width is specified. * * @param column An identifier for the column. If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. * @param width Width of the column in pixels or percents. If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). @@ -75030,7 +75030,7 @@ interface JQuery { } interface IgTreeGridRowSelectors { /** - * Determines row numbering format. + * Determines row numbering format. * * * Valid values: @@ -75040,7 +75040,7 @@ interface IgTreeGridRowSelectors { rowSelectorNumberingMode?: string; /** - * Gets the type of checkboxes rendered in the row selector. Can be set only at initialization. + * Gets the type of checkboxes rendered in the row selector. Can be set only at initialization. * * * Valid values: @@ -75050,25 +75050,25 @@ interface IgTreeGridRowSelectors { checkBoxMode?: string; /** - * Determines whether the row selectors column should contain row numbering + * Determines whether the row selectors column should contain row numbering * */ enableRowNumbering?: boolean; /** - * Determines whether the row selectors column should contain checkboxes + * Determines whether the row selectors column should contain checkboxes * */ enableCheckBoxes?: boolean; /** - * The seed to be added to the default numbering + * The seed to be added to the default numbering * */ rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -75078,7 +75078,7 @@ interface IgTreeGridRowSelectors { rowSelectorColumnWidth?: string|number; /** - * Determines whether the selection feature is required for the row selectors. If set to "false" + * Determines whether the selection feature is required for the row selectors. If set to "false" * the widget will not check for Selection availability. If set to "true" an exception will be thrown if Selection is * not available. * @@ -75086,24 +75086,24 @@ interface IgTreeGridRowSelectors { requireSelection?: boolean; /** - * Determines whether checkboxes will be shown only if row selectors are on focus/selected. + * Determines whether checkboxes will be shown only if row selectors are on focus/selected. * */ showCheckBoxesOnFocus?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Enables/disables showing an overlay after clicking on the header checkbox, which allows selecting all records from all pages. + * Enables/disables showing an overlay after clicking on the header checkbox, which allows selecting all records from all pages. * */ enableSelectAllForPaging?: boolean; /** - * Custom template for "select all" overlay with paging + * Custom template for "select all" overlay with paging * Element with attribute data-rs-select-all is used for sellecting all the records * Element with attribute data-rs-close-all is used for closing the overlay * The default template is "
You have selected ${checked} records. Select all ${totalRecordsCount} records
" @@ -75113,7 +75113,7 @@ interface IgTreeGridRowSelectors { selectAllForPagingTemplate?: string; /** - * Custom template for "deselect all" overlay with paging + * Custom template for "deselect all" overlay with paging * Element with attribute data-rs-deselect-all is used for sellecting all the records * Element with attribute data-rs-close-all is used for closing the overlay * The default template is "
You have deselected ${unchecked} records. Deselect all ${totalRecordsCount} records
" @@ -75123,7 +75123,7 @@ interface IgTreeGridRowSelectors { deselectAllForPagingTemplate?: string; /** - * Event fired after a row selector is clicked. + * Event fired after a row selector is clicked. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.fixedRow to get reference to the fixed row the clicked row selector resides in(if there are fixed columns). @@ -75136,7 +75136,7 @@ interface IgTreeGridRowSelectors { rowSelectorClicked?: RowSelectorClickedEvent; /** - * Event fired when a row selector checkbox is changing. + * Event fired when a row selector checkbox is changing. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.rowIndex to get the index of the row the clicked row selector resides in. @@ -75151,7 +75151,7 @@ interface IgTreeGridRowSelectors { checkBoxStateChanging?: CheckBoxStateChangingEvent; /** - * Event fired after a row selector checkbox had changed state. + * Event fired after a row selector checkbox had changed state. * Function takes arguments evt and ui. * Use ui.row to get reference to the row the clicked row selector resides in. * Use ui.rowIndex to get the index of the row the clicked row selector resides in. @@ -75165,7 +75165,7 @@ interface IgTreeGridRowSelectors { checkBoxStateChanged?: CheckBoxStateChangedEvent; /** - * Option for igTreeGridRowSelectors + * Option for igTreeGridRowSelectors */ [optionName: string]: any; } @@ -75173,7 +75173,7 @@ interface IgTreeGridRowSelectorsMethods { destroy(): void; /** - * Change the check state of a row by row id + * Change the check state of a row by row id * * @param rowId Row Id * @param toCheck The new check state of the checkbox - true for checked or false for unchecked @@ -75181,7 +75181,7 @@ interface IgTreeGridRowSelectorsMethods { changeCheckStateById(rowId: Object, toCheck: boolean): void; /** - * Changes the check state of a row by index to specified value + * Changes the check state of a row by index to specified value * * @param index Row index * @param toCheck The new check state of the checkbox - true for checked or false for unchecked @@ -75189,36 +75189,36 @@ interface IgTreeGridRowSelectorsMethods { changeCheckState(index: number, toCheck: boolean): void; /** - * Toggles the check state of a row by row id + * Toggles the check state of a row by row id * * @param rowId Row Id */ toggleCheckStateById(rowId: Object): void; /** - * Toggles the check state of a row by index + * Toggles the check state of a row by index * * @param index Row index */ toggleCheckState(index: number): void; /** - * Gets an array of all the checked rows. Every object from the array has the following format { element: , id: , index: } + * Gets an array of all the checked rows. Every object from the array has the following format { element: , id: , index: } */ checkedRows(): any[]; /** - * Gets an array of all the partially checked rows. Every object from the array has the following format { element: , id: , index: } + * Gets an array of all the partially checked rows. Every object from the array has the following format { element: , id: , index: } */ partiallyCheckedRows(): any[]; /** - * Gets an array of all the unchecked rows. Every object from the array has the following format { element: , id: , index: } + * Gets an array of all the unchecked rows. Every object from the array has the following format { element: , id: , index: } */ uncheckedRows(): any[]; /** - * Returns the check state of the row by id. + * Returns the check state of the row by id. * * @param rowId */ @@ -75520,19 +75520,19 @@ interface JQuery { } interface IgTreeGridSelection { /** - * Enables / Disables multiple selection of cells and rows - depending on the mode + * Enables / Disables multiple selection of cells and rows - depending on the mode * */ multipleSelection?: boolean; /** - * Enables / disables selection via dragging with the mouse - only applicable for cell selection + * Enables / disables selection via dragging with the mouse - only applicable for cell selection * */ mouseDragSelect?: boolean; /** - * Defines type of the selection. + * Defines type of the selection. * * * Valid values: @@ -75542,49 +75542,49 @@ interface IgTreeGridSelection { mode?: string; /** - * Enables / disables activation of rows and cells. Activation implies ability to perform navigating through cells and rows via the keyboard, and selecting rows and cells using CTRL / SHIFT - in the way cells/rows are selected in Ms Excel + * Enables / disables activation of rows and cells. Activation implies ability to perform navigating through cells and rows via the keyboard, and selecting rows and cells using CTRL / SHIFT - in the way cells/rows are selected in Ms Excel * */ activation?: boolean; /** - * If wrapAround is enabled and selection is on the first or last row or cell, then when the end user tries to go beyond that, the first/last row or cell will be selected + * If wrapAround is enabled and selection is on the first or last row or cell, then when the end user tries to go beyond that, the first/last row or cell will be selected * */ wrapAround?: boolean; /** - * If true will basically skip going into child grids with down / up / right / left arrow keys, when in the context of hierarchical grid + * If true will basically skip going into child grids with down / up / right / left arrow keys, when in the context of hierarchical grid * */ skipChildren?: boolean; /** - * If true multiple selection of cells is done as if CTRL is being held. the option is disregarded if mode is set to row. this option is useful for enabling multiple discountinued selection on touch environments. + * If true multiple selection of cells is done as if CTRL is being held. the option is disregarded if mode is set to row. this option is useful for enabling multiple discountinued selection on touch environments. * */ multipleCellSelectOnClick?: boolean; /** - * Enables / disables selection via continuous touch event - only applicable for cell selection and touch-supported environments + * Enables / disables selection via continuous touch event - only applicable for cell selection and touch-supported environments * */ touchDragSelect?: boolean; /** - * Enables / disables selection persistance between states. + * Enables / disables selection persistance between states. * */ persist?: boolean; /** - * Enables / disables the ability to ctrl drag multiple selection windows when selection mode is 'cell' + * Enables / disables the ability to ctrl drag multiple selection windows when selection mode is 'cell' * */ allowMultipleRangeSelection?: boolean; /** - * Event fired before row(s) are about to be selected (cancellable). + * Event fired before row(s) are about to be selected (cancellable). * Return false in order to cancel selection changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -75600,7 +75600,7 @@ interface IgTreeGridSelection { rowSelectionChanging?: RowSelectionChangingEvent; /** - * Event fired after row(s) are selected. + * Event fired after row(s) are selected. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -75613,7 +75613,7 @@ interface IgTreeGridSelection { rowSelectionChanged?: RowSelectionChangedEvent; /** - * Event fired before cell(s) are about to be selected (cancellable). + * Event fired before cell(s) are about to be selected (cancellable). * Return false in order to cancel cell selection changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -75634,7 +75634,7 @@ interface IgTreeGridSelection { cellSelectionChanging?: CellSelectionChangingEvent; /** - * Event fired after cell(s) are selected. + * Event fired after cell(s) are selected. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -75650,7 +75650,7 @@ interface IgTreeGridSelection { cellSelectionChanged?: CellSelectionChangedEvent; /** - * Event fired before a cell becomes active (focus style applied) (cancellable). + * Event fired before a cell becomes active (focus style applied) (cancellable). * Return false in order to cancel active cell changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -75666,7 +75666,7 @@ interface IgTreeGridSelection { activeCellChanging?: ActiveCellChangingEvent; /** - * Event fired after a cell becomes active (focus style applied). + * Event fired after a cell becomes active (focus style applied). * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -75681,7 +75681,7 @@ interface IgTreeGridSelection { activeCellChanged?: ActiveCellChangedEvent; /** - * Event fired before a row becomes active (focus style applied) (cancellable). + * Event fired before a row becomes active (focus style applied) (cancellable). * Return false in order to cancel active row changing. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. @@ -75694,7 +75694,7 @@ interface IgTreeGridSelection { activeRowChanging?: ActiveRowChangingEvent; /** - * Event fired after a row becomes active (focus style applied). + * Event fired after a row becomes active (focus style applied). * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSelection. * Use ui.owner.grid to get reference to the grid. @@ -75706,7 +75706,7 @@ interface IgTreeGridSelection { activeRowChanged?: ActiveRowChangedEvent; /** - * Option for igTreeGridSelection + * Option for igTreeGridSelection */ [optionName: string]: any; } @@ -75714,19 +75714,19 @@ interface IgTreeGridSelectionMethods { destroy(): void; /** - * Selects a row by row id + * Selects a row by row id * * @param id Row Id */ selectRowById(id: Object): void; /** - * Clears all selected cells, selected rows, active cell and active row. Also updates the UI accordingly + * Clears all selected cells, selected rows, active cell and active row. Also updates the UI accordingly */ clearSelection(): void; /** - * Selects a cell by row/col + * Selects a cell by row/col * * @param row Row index * @param col Column index @@ -75735,7 +75735,7 @@ interface IgTreeGridSelectionMethods { selectCell(row: number, col: number, isFixed?: boolean): void; /** - * Selects a cell by row id/column key + * Selects a cell by row id/column key * * @param id Row Id * @param colKey Column key @@ -75743,7 +75743,7 @@ interface IgTreeGridSelectionMethods { selectCellById(id: Object, colKey: string): void; /** - * Deselects a cell by row/col + * Deselects a cell by row/col * * @param row Row index * @param col Column index @@ -75752,7 +75752,7 @@ interface IgTreeGridSelectionMethods { deselectCell(row: number, col: number, isFixed?: boolean): void; /** - * Deselects a cell by row id/column key + * Deselects a cell by row id/column key * * @param id Row Id * @param colKey Column key @@ -75760,61 +75760,61 @@ interface IgTreeGridSelectionMethods { deselectCellById(id: Object, colKey: string): void; /** - * Selects a row by index + * Selects a row by index * * @param index Row index */ selectRow(index: number): void; /** - * Deselects a row by index + * Deselects a row by index * * @param index Row index */ deselectRow(index: number): void; /** - * Deselects a row by row id + * Deselects a row by row id * * @param id Row Id */ deselectRowById(id: Object): void; /** - * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . + * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** - * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . + * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . * - * If multiple selection is disabled the function will return null. + * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** - * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** - * Returns the currently selected row that has the format { element: , index: }, if any. + * Returns the currently selected row that has the format { element: , index: }, if any. * - * If multiple selection is enabled the function will return null. + * If multiple selection is enabled the function will return null. */ selectedRow(): Object; /** - * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. + * Returns the currently active (focused) cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. */ activeCell(): Object; /** - * Returns the currently active (focused) row that has the format { element: , index: }, if any. + * Returns the currently active (focused) row that has the format { element: , index: }, if any. */ activeRow(): Object; } @@ -76247,19 +76247,19 @@ interface JQuery { } interface IgTreeGridSorting { /** - * Specifies from which data bound level to be applied sorting - 0 is the first level + * Specifies from which data bound level to be applied sorting - 0 is the first level * */ fromLevel?: number; /** - * Specifies to which data bound level to be applied sorting - if -1 sorting should be applied to the last data bound level + * Specifies to which data bound level to be applied sorting - if -1 sorting should be applied to the last data bound level * */ toLevel?: number; /** - * Defines local or remote sorting operations. + * Defines local or remote sorting operations. * * * Valid values: @@ -76269,37 +76269,37 @@ interface IgTreeGridSorting { type?: string; /** - * Enables or disables the case sensitivity of the sorting. Works only for [local](ui.iggridsorting#options:type) sorting. + * Enables or disables the case sensitivity of the sorting. Works only for [local](ui.iggridsorting#options:type) sorting. * */ caseSensitive?: boolean; /** - * Enables/disables special styling for sorted columns. If false, sorted column cells will not have any special sort-related styling. + * Enables/disables special styling for sorted columns. If false, sorted column cells will not have any special sort-related styling. * */ applySortedColumnCss?: boolean; /** - * URL param name which specifies how sorting expressions will be encoded in the URL. Uses OData conventions. ex: ?sort(col1)=asc + * URL param name which specifies how sorting expressions will be encoded in the URL. Uses OData conventions. ex: ?sort(col1)=asc * */ sortUrlKey?: string; /** - * URL param value for ascending type of sorting. Uses OData conventions. Example: ?sort(col1)=asc + * URL param value for ascending type of sorting. Uses OData conventions. Example: ?sort(col1)=asc * */ sortUrlKeyAscValue?: string; /** - * URL param value for descending type of sorting. Uses OData conventions. Example: ?sort(col1)=desc + * URL param value for descending type of sorting. Uses OData conventions. Example: ?sort(col1)=desc * */ sortUrlKeyDescValue?: string; /** - * Defines single column sorting or multiple column sorting. + * Defines single column sorting or multiple column sorting. * * * Valid values: @@ -76309,13 +76309,13 @@ interface IgTreeGridSorting { mode?: string; /** - * Custom sort function(or name of the function as a string) accepting three parameters - the data to be sorted, an array of data source field definitions, and the direction to sort with (optional). The function should return the sorted data array. + * Custom sort function(or name of the function as a string) accepting three parameters - the data to be sorted, an array of data source field definitions, and the direction to sort with (optional). The function should return the sorted data array. * */ customSortFunction?: Function; /** - * Specifies which direction to use on the first click / keydown, if the column is sorted for the first time. + * Specifies which direction to use on the first click / keydown, if the column is sorted for the first time. * * * Valid values: @@ -76325,48 +76325,48 @@ interface IgTreeGridSorting { firstSortDirection?: string; /** - * Custom sorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format + * Custom sorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format */ sortedColumnTooltip?: string; /** - * Specifies whether sorting to be applied immediately when click sort/unsort columns when using the multiple sorting dialog. When it is false Apply button shows and sorting is applied when the button is clicked. + * Specifies whether sorting to be applied immediately when click sort/unsort columns when using the multiple sorting dialog. When it is false Apply button shows and sorting is applied when the button is clicked. * */ modalDialogSortOnClick?: boolean; /** - * Specifies sortby button text for each unsorted column in multiple sorting dialog. + * Specifies sortby button text for each unsorted column in multiple sorting dialog. * */ modalDialogSortByButtonText?: string; /** - * Specifies sortby button label for each unsorted column in multiple sorting dialog. + * Specifies sortby button label for each unsorted column in multiple sorting dialog. * */ modalDialogResetButtonLabel?: string; /** - * Specifies caption for each descending sorted column in multiple sorting dialog. + * Specifies caption for each descending sorted column in multiple sorting dialog. * */ modalDialogCaptionButtonDesc?: string; /** - * Specifies caption for each ascending sorted column in multiple sorting dialog. + * Specifies caption for each ascending sorted column in multiple sorting dialog. * */ modalDialogCaptionButtonAsc?: string; /** - * Specifies caption for unsort button in multiple sorting dialog. + * Specifies caption for unsort button in multiple sorting dialog. * */ modalDialogCaptionButtonUnsort?: string; /** - * Specifies width of multiple sorting dialog. + * Specifies width of multiple sorting dialog. * * * Valid values: @@ -76376,7 +76376,7 @@ interface IgTreeGridSorting { modalDialogWidth?: string|number; /** - * Specifies height of multiple sorting dialog. + * Specifies height of multiple sorting dialog. * * * Valid values: @@ -76386,67 +76386,67 @@ interface IgTreeGridSorting { modalDialogHeight?: string|number; /** - * Specifies time of milliseconds for animation duration to show/hide modal dialog. + * Specifies time of milliseconds for animation duration to show/hide modal dialog. * */ modalDialogAnimationDuration?: number; /** - * Specifies the text of the feature chooser sorting button. + * Specifies the text of the feature chooser sorting button. * */ featureChooserText?: string; /** - * Custom unsorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format. + * Custom unsorted column tooltip in [igTemplating](http://www.igniteui.com/help/igtemplating-overview) format. * */ unsortedColumnTooltip?: string; /** - * A list of custom column settings that specify custom sorting settings for a specific column (whether sorting is enabled / disabled, default sort direction, first sort direction, etc.). + * A list of custom column settings that specify custom sorting settings for a specific column (whether sorting is enabled / disabled, default sort direction, first sort direction, etc.). * */ columnSettings?: IgGridSortingColumnSetting[]; /** - * Specifies caption text for multiple sorting dialog. + * Specifies caption text for multiple sorting dialog. * */ modalDialogCaptionText?: string; /** - * Specifies text of button which apply changes in modal dialog. + * Specifies text of button which apply changes in modal dialog. * */ modalDialogButtonApplyText?: string; /** - * Specifies text of button which cancels the changes in the advanced sorting modal dialog. + * Specifies text of button which cancels the changes in the advanced sorting modal dialog. * */ modalDialogButtonCancelText?: string; /** - * Specifies the text shown in the feature chooser item for sorting in ascending order (displayed only on touch environment). + * Specifies the text shown in the feature chooser item for sorting in ascending order (displayed only on touch environment). * */ featureChooserSortAsc?: string; /** - * Specifies the text shown in the feature chooser item for sorting in descending order (displayed only on touch environment). + * Specifies the text shown in the feature chooser item for sorting in descending order (displayed only on touch environment). * */ featureChooserSortDesc?: string; /** - * Enables/disables sorting persistence when the grid is rebound. + * Enables/disables sorting persistence when the grid is rebound. * */ persist?: boolean; /** - * Controls containment behavior of multiple sorting dialog. + * Controls containment behavior of multiple sorting dialog. * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area @@ -76454,19 +76454,19 @@ interface IgTreeGridSorting { sortingDialogContainment?: string; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; /** - * Event fired before sorting is invoked for a certain column. + * Event fired before sorting is invoked for a certain column. * Return false in order to cancel column sorting. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSorting. @@ -76478,7 +76478,7 @@ interface IgTreeGridSorting { columnSorting?: ColumnSortingEvent; /** - * Event fired after the column has already been sorted and data - re-rendered. + * Event fired after the column has already been sorted and data - re-rendered. * Function takes arguments evt and ui. * Use ui.owner to get reference to GridSorting. * Use ui.owner.grid to get reference to grid. @@ -76489,7 +76489,7 @@ interface IgTreeGridSorting { columnSorted?: ColumnSortedEvent; /** - * Event fired before the modal dialog is opened. + * Event fired before the modal dialog is opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76498,7 +76498,7 @@ interface IgTreeGridSorting { modalDialogOpening?: ModalDialogOpeningEvent; /** - * Event fired after the modal dialog is already opened. + * Event fired after the modal dialog is already opened. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76507,7 +76507,7 @@ interface IgTreeGridSorting { modalDialogOpened?: ModalDialogOpenedEvent; /** - * Event fired every time the modal dialog changes its position. + * Event fired every time the modal dialog changes its position. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76518,7 +76518,7 @@ interface IgTreeGridSorting { modalDialogMoving?: ModalDialogMovingEvent; /** - * Event fired before the modal dialog is closed. + * Event fired before the modal dialog is closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76527,7 +76527,7 @@ interface IgTreeGridSorting { modalDialogClosing?: ModalDialogClosingEvent; /** - * Event fired after the modal dialog has been closed. + * Event fired after the modal dialog has been closed. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76536,7 +76536,7 @@ interface IgTreeGridSorting { modalDialogClosed?: ModalDialogClosedEvent; /** - * Event fired before the contents of the modal dialog are rendered. + * Event fired before the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76545,7 +76545,7 @@ interface IgTreeGridSorting { modalDialogContentsRendering?: ModalDialogContentsRenderingEvent; /** - * Event fired after the contents of the modal dialog are rendered. + * Event fired after the contents of the modal dialog are rendered. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76554,7 +76554,7 @@ interface IgTreeGridSorting { modalDialogContentsRendered?: ModalDialogContentsRenderedEvent; /** - * Event fired when sorting of column is changed in modal dialog. Column should be sorted + * Event fired when sorting of column is changed in modal dialog. Column should be sorted * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76565,7 +76565,7 @@ interface IgTreeGridSorting { modalDialogSortingChanged?: ModalDialogSortingChangedEvent; /** - * Event fired when button to unsort column is clicked in modal dialog + * Event fired when button to unsort column is clicked in modal dialog * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76575,7 +76575,7 @@ interface IgTreeGridSorting { modalDialogButtonUnsortClick?: ModalDialogButtonUnsortClickEvent; /** - * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog + * Event fired when column(which is not sorted) is clicked to be sorted in modal dialog * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76585,7 +76585,7 @@ interface IgTreeGridSorting { modalDialogSortClick?: ModalDialogSortClickEvent; /** - * Event fired when button Apply in modal dialog is clicked + * Event fired when button Apply in modal dialog is clicked * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76595,7 +76595,7 @@ interface IgTreeGridSorting { modalDialogButtonApplyClick?: ModalDialogButtonApplyClickEvent; /** - * Event fired when the button to reset sorting is clicked. + * Event fired when the button to reset sorting is clicked. * The handler function takes arguments evt and ui. * Use ui.owner to get the reference to the GridSorting widget. * Use ui.owner.grid to get the reference to the grid widget. @@ -76604,13 +76604,13 @@ interface IgTreeGridSorting { modalDialogButtonResetClick?: ModalDialogButtonResetClickEvent; /** - * Option for igTreeGridSorting + * Option for igTreeGridSorting */ [optionName: string]: any; } interface IgTreeGridSortingMethods { /** - * Returns whether a column with the specified columnKey is sorted(taken from the data source sorting expressions) + * Returns whether a column with the specified columnKey is sorted(taken from the data source sorting expressions) * * @param columnKey Column key (string) */ @@ -76618,7 +76618,7 @@ interface IgTreeGridSortingMethods { destroy(): void; /** - * Sorts the data in a grid column and updates the UI. + * Sorts the data in a grid column and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) @@ -76627,17 +76627,17 @@ interface IgTreeGridSortingMethods { sortColumn(index: Object, direction: Object, header: Object): void; /** - * Sorts the data in grid columns and updates the UI.\ + * Sorts the data in grid columns and updates the UI.\ */ sortMultiple(): void; /** - * Removes current sorting(for all sorted columns) and updates the UI. + * Removes current sorting(for all sorted columns) and updates the UI. */ clearSorting(): void; /** - * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. + * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. * @param header - if specified client events should be fired @@ -76645,24 +76645,24 @@ interface IgTreeGridSortingMethods { unsortColumn(index: Object, header: Object): void; /** - * Opens the multiple sorting dialog. + * Opens the multiple sorting dialog. */ openMultipleSortingDialog(): void; /** - * Closes the multiple sorting dialog. + * Closes the multiple sorting dialog. */ closeMultipleSortingDialog(): void; /** - * Renders content of multiple sorting dialog - sorted and unsorted columns. + * Renders content of multiple sorting dialog - sorted and unsorted columns. * * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; /** - * Remove clear button for multiple sorting dialog + * Remove clear button for multiple sorting dialog */ removeDialogClearButton(): void; } @@ -77457,7 +77457,7 @@ interface JQuery { } interface IgTreeGridTooltips { /** - * determines the tooltip visibility option + * determines the tooltip visibility option * * * Valid values: @@ -77468,7 +77468,7 @@ interface IgTreeGridTooltips { visibility?: string; /** - * controls the tooltip's style + * controls the tooltip's style * * * Valid values: @@ -77478,50 +77478,50 @@ interface IgTreeGridTooltips { style?: string; /** - * The time in milliseconds after which tooltip will show when + * The time in milliseconds after which tooltip will show when * mouse cursor is hovered over a cell. * */ showDelay?: number; /** - * Type="integer" The time in milliseconds after which tooltip hides when mouse + * Type="integer" The time in milliseconds after which tooltip hides when mouse * cursor gets outside of the cell. * */ hideDelay?: number; /** - * A list of custom column settings that specify custom tooltip settings for a specific column (whether tooltips are enabled / disabled) + * A list of custom column settings that specify custom tooltip settings for a specific column (whether tooltips are enabled / disabled) * */ columnSettings?: IgGridTooltipsColumnSettings; /** - * Sets the time tooltip fades in and out when showing/hiding + * Sets the time tooltip fades in and out when showing/hiding * */ fadeTimespan?: number; /** - * Sets the left position of the tooltip relative to the mouse cursor + * Sets the left position of the tooltip relative to the mouse cursor * */ cursorLeftOffset?: number; /** - * Sets the top position of the tooltip relative to the mouse cursor + * Sets the top position of the tooltip relative to the mouse cursor * */ cursorTopOffset?: number; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired when the mouse has hovered on an element long enough to display a tooltip + * Event fired when the mouse has hovered on an element long enough to display a tooltip * use args.owner to get a reference to the widget * use args.tooltip to get or set the string to be displayed * use args.value to get the value of the cell the tooltip is displayed for @@ -77533,7 +77533,7 @@ interface IgTreeGridTooltips { tooltipShowing?: TooltipShowingEvent; /** - * Event fired after a tooltip is shown + * Event fired after a tooltip is shown * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip is displayed for @@ -77545,7 +77545,7 @@ interface IgTreeGridTooltips { tooltipShown?: TooltipShownEvent; /** - * Event fired when the mouse has left an element and the tooltip is about to hide + * Event fired when the mouse has left an element and the tooltip is about to hide * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip is displayed for @@ -77557,7 +77557,7 @@ interface IgTreeGridTooltips { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * use args.owner to get a reference to the widget * use args.tooltip to get the string displayed in the tooltip * use args.value to get the value of the cell the tooltip was displayed for @@ -77569,7 +77569,7 @@ interface IgTreeGridTooltips { tooltipHidden?: TooltipHiddenEvent; /** - * Option for igTreeGridTooltips + * Option for igTreeGridTooltips */ [optionName: string]: any; } @@ -77577,7 +77577,7 @@ interface IgTreeGridTooltipsMethods { destroy(): void; /** - * Returns the ID of the parent div element bounding the ruler and the tooltip container + * Returns the ID of the parent div element bounding the ruler and the tooltip container */ id(): string; } @@ -77828,31 +77828,31 @@ interface JQuery { } interface IgTreeGridUpdating { /** - * Specifies whether to enable or disable adding children to rows. + * Specifies whether to enable or disable adding children to rows. * */ enableAddChild?: boolean; /** - * Specifies the add child tooltip text. + * Specifies the add child tooltip text. * */ addChildTooltip?: string; /** - * Specifies the label of the add child button in touch environment. + * Specifies the label of the add child button in touch environment. * */ addChildButtonLabel?: string; /** - * A list of custom column options that specify editing and validation settings for a specific column. + * A list of custom column options that specify editing and validation settings for a specific column. * */ columnSettings?: IgGridUpdatingColumnSetting[]; /** - * Specifies the edit mode. + * Specifies the edit mode. * * * Valid values: @@ -77864,144 +77864,144 @@ interface IgTreeGridUpdating { editMode?: string; /** - * Specifies if deleting rows through the UI is enabled. + * Specifies if deleting rows through the UI is enabled. * */ enableDeleteRow?: boolean; /** - * Specifies if adding rows through the UI is enabled. When enabled an additional row is rendered at the bottom of the grid's header that works as a button. When the end-user clicks on it edit mode is initiated either through a dialog (when [editMode](ui.iggridupdating#options:editMode) is 'dialog') or mimicking the look and feel of 'row' [editMode](ui.iggridupdating#options:editMode) (when [editMode](ui.iggridupdating#options:editMode) is 'row' or 'cell'). + * Specifies if adding rows through the UI is enabled. When enabled an additional row is rendered at the bottom of the grid's header that works as a button. When the end-user clicks on it edit mode is initiated either through a dialog (when [editMode](ui.iggridupdating#options:editMode) is 'dialog') or mimicking the look and feel of 'row' [editMode](ui.iggridupdating#options:editMode) (when [editMode](ui.iggridupdating#options:editMode) is 'row' or 'cell'). * */ enableAddRow?: boolean; /** - * Specifies if the value of each editable column in the grid should be validated. The validation is done based on the rules of their corresponding editors. + * Specifies if the value of each editable column in the grid should be validated. The validation is done based on the rules of their corresponding editors. * */ validation?: boolean; /** - * Specifies the label for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneLabel is used. + * Specifies the label for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneLabel is used. * */ doneLabel?: string; /** - * Specifies the title for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneTooltip is used. + * Specifies the title for the Done editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.doneTooltip is used. * */ doneTooltip?: string; /** - * Specifies the label for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelLabel is used. + * Specifies the label for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelLabel is used. * */ cancelLabel?: string; /** - * Specifies the title for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelTooltip is used. + * Specifies the title for the Cancel editing button (only applicable when the [showDoneCancelButtons](ui.iggridupdating#options:showDoneCancelButtons) option is enabled). If not set, $.ig.GridUpdating.locale.cancelTooltip is used. * */ cancelTooltip?: string; /** - * Specifies the label for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowLabel is used. + * Specifies the label for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowLabel is used. * */ addRowLabel?: string; /** - * Specifies the title for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowTooltip is used. + * Specifies the title for the button starting edit mode for row adding. If not set, $.ig.GridUpdating.locale.addRowTooltip is used. * */ addRowTooltip?: string; /** - * Specifies the label for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowLabel is used. + * Specifies the label for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowLabel is used. * */ deleteRowLabel?: string; /** - * Specifies the title for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowTooltip is used. + * Specifies the title for the delete button. If not set, $.ig.GridUpdating.locale.deleteRowTooltip is used. * */ deleteRowTooltip?: string; /** - * Determines if the Done and Cancel buttons will be available as means to end edit mode for [editMode](ui.iggridupdating#options:editMode) 'row' and when adding a new row. + * Determines if the Done and Cancel buttons will be available as means to end edit mode for [editMode](ui.iggridupdating#options:editMode) 'row' and when adding a new row. * */ showDoneCancelButtons?: boolean; /** - * Specifies if an exception should be thrown when the grid's data view changes while there are pending transactions in the data source. The data view changes when the data source performs a sorting, filtering, groupby or paging operation and the exception thrown will prevent the operation from succeeding. All pending transactions must be committed before a data view operation is able to complete. Committing transactions can be done manually through the grid's [commit](ui.iggrid#methods:commit) function or automatically by setting [autoCommit](ui.iggrid#options:autoCommit) to 'true'. + * Specifies if an exception should be thrown when the grid's data view changes while there are pending transactions in the data source. The data view changes when the data source performs a sorting, filtering, groupby or paging operation and the exception thrown will prevent the operation from succeeding. All pending transactions must be committed before a data view operation is able to complete. Committing transactions can be done manually through the grid's [commit](ui.iggrid#methods:commit) function or automatically by setting [autoCommit](ui.iggrid#options:autoCommit) to 'true'. * */ enableDataDirtyException?: boolean; /** - * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. + * Specifies how end-users are able to start edit mode. Possible values: "click", "dblclick", "F2", "enter" and their combinations separated by comma or in array. The keyboard triggers have effect only if the grid cells can receive focus (the grid's [tabIndex](ui.iggrid#options:tabIndex) property should not have a negative value) or Selection is enabled. If "dblclick" is included, then "click" has no effect. * */ startEditTriggers?: string|Array; /** - * Determines if pressing Enter to navigate away from the currently edited cell should move the focus horizontally or vertically (default). + * Determines if pressing Enter to navigate away from the currently edited cell should move the focus horizontally or vertically (default). * */ horizontalMoveOnEnter?: boolean; /** - * Enables excel navigation style. When turned on, the arrow keys can be used for changing the currently edited cell similar to how Tab and Enter behave. When disabled, the arrow keys control the cursor inside editors. + * Enables excel navigation style. When turned on, the arrow keys can be used for changing the currently edited cell similar to how Tab and Enter behave. When disabled, the arrow keys control the cursor inside editors. * */ excelNavigationMode?: boolean; /** - * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. + * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property succeeds. The function will be called with arguments representing the data returned by the server. * */ saveChangesSuccessHandler?: Function|string; /** - * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. + * Sets a custom function to be called when the AJAX request to the URL specified by the [updateUrl](ui.iggrid#options:updateUrl) property fails. The function will be called with arguments representing the data returned by the server. * */ saveChangesErrorHandler?: Function|string; /** - * On touch-enabled devices specifies the swipe distance for the delete button to appear. + * On touch-enabled devices specifies the swipe distance for the delete button to appear. * */ swipeDistance?: string|number; /** - * Controls if navigation will wrap around the grid. The feature will never wrap around virtual grids. + * Controls if navigation will wrap around the grid. The feature will never wrap around virtual grids. * */ wrapAround?: boolean; /** - * A list of options controlling the rendering behavior of the row edit dialog. If [editMode](ui.iggridupdating#options:editMode) is not 'dialog' these have no effect. + * A list of options controlling the rendering behavior of the row edit dialog. If [editMode](ui.iggridupdating#options:editMode) is not 'dialog' these have no effect. * */ rowEditDialogOptions?: IgGridUpdatingRowEditDialogOptions; /** - * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. For more information on how to utilize this property, please refer to the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic. + * Name of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog. For more information on how to utilize this property, please refer to the [Extending igGrid Modal Dialog](http://www.igniteui.com/help/extending-iggrid-modal-dialog) topic. * */ dialogWidget?: string; /** - * Enables/disables feature inheritance for the child layouts in igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts in igHierarchicalGrid. */ inherit?: boolean; /** - * Event fired before row editing begins. + * Event fired before row editing begins. * Return false in order to cancel editing. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78012,7 +78012,7 @@ interface IgTreeGridUpdating { editRowStarting?: EditRowStartingEvent; /** - * Event fired after row editing begins. + * Event fired after row editing begins. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78022,7 +78022,7 @@ interface IgTreeGridUpdating { editRowStarted?: EditRowStartedEvent; /** - * Event fired before row editing ends. + * Event fired before row editing ends. * Return false in order to prevent the grid from exiting edit mode. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78036,7 +78036,7 @@ interface IgTreeGridUpdating { editRowEnding?: EditRowEndingEvent; /** - * Event fired after row editing ends. + * Event fired after row editing ends. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78049,7 +78049,7 @@ interface IgTreeGridUpdating { editRowEnded?: EditRowEndedEvent; /** - * Event fired before cell editing begins (including when row editing opens editing for a cell). + * Event fired before cell editing begins (including when row editing opens editing for a cell). * Return false in order to cancel editing. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78064,7 +78064,7 @@ interface IgTreeGridUpdating { editCellStarting?: EditCellStartingEvent; /** - * Event fired after cell editing begins (including when row editing opens editing for a cell). + * Event fired after cell editing begins (including when row editing opens editing for a cell). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78078,7 +78078,7 @@ interface IgTreeGridUpdating { editCellStarted?: EditCellStartedEvent; /** - * Event fired before cell editing ends (including when row editing closes editing for a cell). + * Event fired before cell editing ends (including when row editing closes editing for a cell). * Return false in order to prevent the grid from exiting edit mode (only functions if [editMode](ui.iggridupdating#options:editMode) is 'cell'). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78095,7 +78095,7 @@ interface IgTreeGridUpdating { editCellEnding?: EditCellEndingEvent; /** - * Event fired after cell editing ends (including when row editing closes editing for a cell). + * Event fired after cell editing ends (including when row editing closes editing for a cell). * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78111,7 +78111,7 @@ interface IgTreeGridUpdating { editCellEnded?: EditCellEndedEvent; /** - * Event fired before adding a new row. + * Event fired before adding a new row. * Return false in order to cancel the adding of the new row to the data source. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78122,7 +78122,7 @@ interface IgTreeGridUpdating { rowAdding?: RowAddingEvent; /** - * Event fired after adding a new row. + * Event fired after adding a new row. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78132,7 +78132,7 @@ interface IgTreeGridUpdating { rowAdded?: RowAddedEvent; /** - * Event fired before deleting a row. + * Event fired before deleting a row. * Return false in order to cancel the row's deletion. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78143,7 +78143,7 @@ interface IgTreeGridUpdating { rowDeleting?: RowDeletingEvent; /** - * Event fired after a row is deleted. + * Event fired after a row is deleted. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78153,7 +78153,7 @@ interface IgTreeGridUpdating { rowDeleted?: RowDeletedEvent; /** - * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. + * Event fired before the dataDirtyException is thrown. This can be controlled by the [enableDataDirtyException](ui.iggridupdating#options:enableDataDirtyException) property. Any pending changes may be committed in the handler of this event in order to prevent dataDirtyException from being thrown. * Return false in order to prevent the exception. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. @@ -78162,7 +78162,7 @@ interface IgTreeGridUpdating { dataDirty?: DataDirtyEvent; /** - * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. + * Event fired before editing starts for adding a new row, when Updating generates an automatic primary key for it. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78171,7 +78171,7 @@ interface IgTreeGridUpdating { generatePrimaryKeyValue?: GeneratePrimaryKeyValueEvent; /** - * Event fired before the row edit dialog is opened. + * Event fired before the row edit dialog is opened. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78180,7 +78180,7 @@ interface IgTreeGridUpdating { rowEditDialogBeforeOpen?: RowEditDialogBeforeOpenEvent; /** - * Event fired after the row edit dialog is opened. + * Event fired after the row edit dialog is opened. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78189,7 +78189,7 @@ interface IgTreeGridUpdating { rowEditDialogAfterOpen?: RowEditDialogAfterOpenEvent; /** - * Event fired before the row edit dialog is closed. + * Event fired before the row edit dialog is closed. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78198,7 +78198,7 @@ interface IgTreeGridUpdating { rowEditDialogBeforeClose?: RowEditDialogBeforeCloseEvent; /** - * Event fired after the row edit dialog is closed. + * Event fired after the row edit dialog is closed. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78207,7 +78207,7 @@ interface IgTreeGridUpdating { rowEditDialogAfterClose?: RowEditDialogAfterCloseEvent; /** - * Event fired after the row edit dialog is rendered. + * Event fired after the row edit dialog is rendered. * Function takes arguments evt and ui. * Use ui.owner to get a reference to GridUpdating. * Use ui.owner.grid to get a reference to the grid. @@ -78216,13 +78216,13 @@ interface IgTreeGridUpdating { rowEditDialogContentsRendered?: RowEditDialogContentsRenderedEvent; /** - * Option for igTreeGridUpdating + * Option for igTreeGridUpdating */ [optionName: string]: any; } interface IgTreeGridUpdatingMethods { /** - * Adds a new child to a specific row. It also creates a transaction and updates the UI. + * Adds a new child to a specific row. It also creates a transaction and updates the UI. * * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . * @param parentId The ID of the targeted row. @@ -78230,7 +78230,7 @@ interface IgTreeGridUpdatingMethods { addChild(values: Object, parentId: Object): void; /** - * Starts editing for adding a new child for specific row. + * Starts editing for adding a new child for specific row. * * @param parentId The ID of the targeted row. * @param raiseEvents Specifies whether or not updating events should be raised for this operation. @@ -78238,21 +78238,21 @@ interface IgTreeGridUpdatingMethods { startAddChildFor(parentId: Object, raiseEvents?: Object): void; /** - * Shows the "Add Child" button for specific row. + * Shows the "Add Child" button for specific row. * * @param row A jQuery object of the targeted row. */ showAddChildButtonFor(row: Object): void; /** - * Hides the "Add Child" button. + * Hides the "Add Child" button. */ hideAddChildButton(): void; destroy(): void; /** - * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. - * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. + * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. + * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. * * @param rowId The primary key of the row the cell is a child of. * @param colKey The column key of the cell. @@ -78261,8 +78261,8 @@ interface IgTreeGridUpdatingMethods { setCellValue(rowId: Object, colKey: string, value: Object): void; /** - * Sets values for specified cells in a row. It also creates a transaction and updates the UI. - * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. + * Sets values for specified cells in a row. It also creates a transaction and updates the UI. + * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. * * @param rowId The primary key of the row to update. * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . @@ -78270,21 +78270,21 @@ interface IgTreeGridUpdatingMethods { updateRow(rowId: Object, values: Object): void; /** - * Adds a new row to the grid. It also creates a transaction and updates the UI. + * Adds a new row to the grid. It also creates a transaction and updates the UI. * * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ addRow(values: Object): void; /** - * Deletes a row from the grid. It also creates a transaction and updates the UI. + * Deletes a row from the grid. It also creates a transaction and updates the UI. * * @param rowId The primary key of the row to delete. */ deleteRow(rowId: Object): void; /** - * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). + * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). * * @param rowId The row id. * @param column The column key or index. @@ -78293,14 +78293,14 @@ interface IgTreeGridUpdatingMethods { startEdit(rowId: Object, column: Object, raiseEvents?: boolean): boolean; /** - * Starts editing for adding a new row. + * Starts editing for adding a new row. * * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddRowEdit(raiseEvents?: boolean): boolean; /** - * Ends the currently active edit mode. + * Ends the currently active edit mode. * * @param update Specifies if the edit process should accept the current changes. Default is 'false'. * @param raiseEvents Specifies whether or not updating events should be raised for this operation. @@ -78308,24 +78308,24 @@ interface IgTreeGridUpdatingMethods { endEdit(update?: boolean, raiseEvents?: boolean): boolean; /** - * Finds and returns the key of the first column the editor for which has invalid value. + * Finds and returns the key of the first column the editor for which has invalid value. */ findInvalid(): string; /** - * Checks if the grid is in edit mode. + * Checks if the grid is in edit mode. */ isEditing(): boolean; /** - * Gets the editor for a column by the column key. That method can be used only after the editor has been created. + * Gets the editor for a column by the column key. That method can be used only after the editor has been created. * * @param key The key of the column. */ editorForKey(key: string): Object; /** - * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. + * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. * * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. * @param create Requests to create the editor if it has not been created yet. @@ -78333,14 +78333,14 @@ interface IgTreeGridUpdatingMethods { editorForCell(cell: string, create?: boolean): Object; /** - * Shows the delete button for specific row. + * Shows the delete button for specific row. * * @param row A jQuery object of the targeted row. */ showDeleteButtonFor(row: Object): void; /** - * Hides the delete button. + * Hides the delete button. */ hideDeleteButton(): void; } @@ -79236,12 +79236,12 @@ interface IgBrowseButton { multipleFiles?: boolean; /** - * M.H. 13 Feb 2014 Fix for bug #164347: Move input from document body to the upload container + * M.H. 13 Feb 2014 Fix for bug #164347: Move input from document body to the upload container */ container?: any; /** - * Option for igBrowseButton + * Option for igBrowseButton */ [optionName: string]: any; } @@ -79250,7 +79250,7 @@ interface IgBrowseButtonMethods { getFilePicker(): void; /** - * $(".selector").igUpload("destroy"); + * $(".selector").igUpload("destroy"); */ destroy(): void; } @@ -79260,22 +79260,22 @@ interface JQuery { interface IgUploadFileExtensionIcons { /** - * Array of string for file extensions + * Array of string for file extensions */ ext?: any[]; /** - * Css classes which sets icon. + * Css classes which sets icon. */ css?: string; /** - * Default icons when the file extension is not found. It is taken only the first item which have def set to true, other are ignored. + * Default icons when the file extension is not found. It is taken only the first item which have def set to true, other are ignored. */ def?: boolean; /** - * Option for IgUploadFileExtensionIcons + * Option for IgUploadFileExtensionIcons */ [optionName: string]: any; } @@ -79286,7 +79286,7 @@ interface FileSelectingEvent { interface FileSelectingEventUIParam { /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79297,17 +79297,17 @@ interface FileSelectedEvent { interface FileSelectedEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get the name of the uploaded file + * Used to get the name of the uploaded file */ filePath?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79318,37 +79318,37 @@ interface FileUploadingEvent { interface FileUploadingEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get the name of the uploaded file + * Used to get the name of the uploaded file */ filePath?: any; /** - * Used totalSize to get the file size of the uploaded file + * Used totalSize to get the file size of the uploaded file */ totalSize?: any; /** - * Used to get uploaded bytes + * Used to get uploaded bytes */ uploadedBytes?: any; /** - * Used to get current file status + * Used to get current file status */ fileStatus?: any; /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. + * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. */ fileInfo?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79359,27 +79359,27 @@ interface FileUploadedEvent { interface FileUploadedEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get the name of the uploaded file + * Used to get the name of the uploaded file */ filePath?: any; /** - * Used totalSize to get the file size of the uploaded file + * Used totalSize to get the file size of the uploaded file */ totalSize?: any; /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. + * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from server side), etc. */ fileInfo?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79390,32 +79390,32 @@ interface FileUploadAbortedEvent { interface FileUploadAbortedEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get the name of the uploaded file + * Used to get the name of the uploaded file */ filePath?: any; /** - * Used totalSize to get the file size of the uploaded file + * Used totalSize to get the file size of the uploaded file */ totalSize?: any; /** - * Used to get uploaded bytes + * Used to get uploaded bytes */ uploadedBytes?: any; /** - * Used to get current file status + * Used to get current file status */ fileStatus?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79426,7 +79426,7 @@ interface CancelAllClickedEvent { interface CancelAllClickedEventUIParam { /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79437,32 +79437,32 @@ interface OnErrorEvent { interface OnErrorEventUIParam { /** - * Used to get current errorCode + * Used to get current errorCode */ errorCode?: any; /** - * Used to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. + * Used to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. */ fileId?: any; /** - * Used to get detailed error description + * Used to get detailed error description */ errorMessage?: any; /** - * Used to get error type - it could be clientside or serverside + * Used to get error type - it could be clientside or serverside */ errorType?: any; /** - * Used to get specific server message returned by server - if errorType is serverside + * Used to get specific server message returned by server - if errorType is serverside */ serverMessage?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79473,17 +79473,17 @@ interface FileExtensionsValidatingEvent { interface FileExtensionsValidatingEventUIParam { /** - * Used to get the full file name + * Used to get the full file name */ fileName?: any; /** - * Used to get file extension + * Used to get file extension */ fileExtension?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79494,22 +79494,22 @@ interface OnXHRLoadEvent { interface OnXHRLoadEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get reference to the original XMLHttpRequest object + * Used to get reference to the original XMLHttpRequest object */ xhr?: any; /** - * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. + * Used to get reference to the fileInfo object - containing information for fileName, fileSize, serverMessage(if returned from the server-side), etc. */ fileInfo?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } @@ -79520,272 +79520,272 @@ interface OnFormDataSubmitEvent { interface OnFormDataSubmitEventUIParam { /** - * Used to get unique identifier of the file + * Used to get unique identifier of the file */ fileId?: any; /** - * Used to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. + * Used to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. */ fileInfo?: any; /** - * Used to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) + * Used to get reference to the original XMLHttpRequest object(if the browser supports HTML 5 file API - if not it is undefined) */ xhr?: any; /** - * Used to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of
+ * Used to get reference to FormData object(if the browser supports HTML5 file API) OR reference to jQuery representation of */ formData?: any; /** - * Used to access the igUpload widget object. + * Used to access the igUpload widget object. */ owner?: any; } interface IgUpload { /** - * Get or set width of the main container of the file upload control. Main container contains all buttons, progressbar, etc. + * Get or set width of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * */ width?: number|string; /** - * Get or set height of the main container of the file upload control. Main container contains all buttons, progressbar, etc. + * Get or set height of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * */ height?: number|string; /** - * Get or set whether the file start upload automatically when it is selected. Default is false. + * Get or set whether the file start upload automatically when it is selected. Default is false. * */ autostartupload?: boolean; /** - * Get or set label for the first shown browse button. When file is selected for the first time this button is hidden. + * Get or set label for the first shown browse button. When file is selected for the first time this button is hidden. * */ labelUploadButton?: string; /** - * Get or set label for browse button in main container. + * Get or set label for browse button in main container. * */ labelAddButton?: string; /** - * Get or set label for summary Clear all button. It will be shown only in multiple upload mode. + * Get or set label for summary Clear all button. It will be shown only in multiple upload mode. * */ labelClearAllButton?: string; /** - * Get or set template for showing summary template. {0} is count of uploaded files. {1} is total count of file to be uploaded. + * Get or set template for showing summary template. {0} is count of uploaded files. {1} is total count of file to be uploaded. * */ labelSummaryTemplate?: string; /** - * Get or set template for showing uploading information in summary progress bar. It will be shown only in multiple upload mode. {0} uploaded filesize. {1} - total file size. + * Get or set template for showing uploading information in summary progress bar. It will be shown only in multiple upload mode. {0} uploaded filesize. {1} - total file size. * */ labelSummaryProgressBarTemplate?: string; /** - * Get or set label for show/hide details button when main container is hidden. + * Get or set label for show/hide details button when main container is hidden. * */ labelShowDetails?: string; /** - * Get or set label for show/hide details button when main container is shown. + * Get or set label for show/hide details button when main container is shown. * */ labelHideDetails?: string; /** - * Get or set label for button cancelling all files. Shown only in multiple upload mode. + * Get or set label for button cancelling all files. Shown only in multiple upload mode. * */ labelSummaryProgressButtonCancel?: string; /** - * Get or set label for start upload batch files. Shown only in multiple upload mode and autostartupload is false. + * Get or set label for start upload batch files. Shown only in multiple upload mode and autostartupload is false. * */ labelSummaryProgressButtonContinue?: string; /** - * Get or set label when upload is finished. Shown only in multiple upload mode. + * Get or set label when upload is finished. Shown only in multiple upload mode. * */ labelSummaryProgressButtonDone?: string; /** - * Get or set filename when it could not be shown the whole file name and should be shorten. + * Get or set filename when it could not be shown the whole file name and should be shorten. * */ labelProgressBarFileNameContinue?: string; /** - * Get or set message shown when max file size of the uploaded file exceeds the limit. + * Get or set message shown when max file size of the uploaded file exceeds the limit. * */ errorMessageMaxFileSizeExceeded?: string; /** - * Get or set error message when ajax call to get file status throws error. + * Get or set error message when ajax call to get file status throws error. * */ errorMessageGetFileStatus?: string; /** - * Get or set error message when ajax call to send cancel upload command. + * Get or set error message when ajax call to send cancel upload command. * */ errorMessageCancelUpload?: string; /** - * Get or set error message when file is not found. + * Get or set error message when file is not found. * */ errorMessageNoSuchFile?: string; /** - * Get or set error message different from the other messages. + * Get or set error message different from the other messages. * */ errorMessageOther?: string; /** - * Get or set error message when file extension validation failed. + * Get or set error message when file extension validation failed. * */ errorMessageValidatingFileExtension?: string; /** - * Get or set error message when AJAX Request to get file size throws error. + * Get or set error message when AJAX Request to get file size throws error. * */ errorMessageAJAXRequestFileSize?: string; /** - * Get or set error message when trying to remove non existing file. + * Get or set error message when trying to remove non existing file. * */ errorMessageTryToRemoveNonExistingFile?: string; /** - * Get or set error message when trying to start non existing file. + * Get or set error message when trying to start non existing file. * */ errorMessageTryToStartNonExistingFile?: string; /** - * Get or set error message when maximum allowed files exceeded. + * Get or set error message when maximum allowed files exceeded. * */ errorMessageMaxUploadedFiles?: string; /** - * Get or set error message when maximum simultaneous files is less or equal to 0. + * Get or set error message when maximum simultaneous files is less or equal to 0. * */ errorMessageMaxSimultaneousFiles?: string; /** - * Get or set error message when trying to drop more than 1 file and mode is single. + * Get or set error message when trying to drop more than 1 file and mode is single. */ errorMessageDropMultipleFilesWhenSingleModel?: string; /** - * Get or set URL for uploading. + * Get or set URL for uploading. * */ uploadUrl?: string; /** - * Get or set URL of HTTPHandler to get information about file upload, current size and also to get commands + * Get or set URL of HTTPHandler to get information about file upload, current size and also to get commands * */ progressUrl?: string; /** - * Get or set file allowed file extensions. When this array is empty - it is not made such validation. Example ["gif", "jpg", "bmp"]. + * Get or set file allowed file extensions. When this array is empty - it is not made such validation. Example ["gif", "jpg", "bmp"]. * */ allowedExtensions?: any[]; /** - * Get or set whether to show File Extension icon + * Get or set whether to show File Extension icon * */ showFileExtensionIcon?: boolean; /** - * Get or set control specific CSS options. For example you can override specific control classes with custom ones. + * Get or set control specific CSS options. For example you can override specific control classes with custom ones. * */ css?: any; /** - * Set icon css classes for specified file extension + * Set icon css classes for specified file extension * */ fileExtensionIcons?: IgUploadFileExtensionIcons; /** - * Get or set multiple or single file upload. In single upload it is possible to upload only one file at the same time. + * Get or set multiple or single file upload. In single upload it is possible to upload only one file at the same time. * */ mode?: any; /** - * Get or set a bool setting that allows user to select(for upload) more than 1 file from the browse dialog at once. HTML 5+ - it is supported by Chrome, MOzilla FF, Safar, Opera latest versions and IE10+ + * Get or set a bool setting that allows user to select(for upload) more than 1 file from the browse dialog at once. HTML 5+ - it is supported by Chrome, MOzilla FF, Safar, Opera latest versions and IE10+ * */ multipleFiles?: boolean; /** - * Get or set the maximum number of allowed files to upload. + * Get or set the maximum number of allowed files to upload. * */ maxUploadedFiles?: number; /** - * Get or set count of files that could be uploaded at the same time. + * Get or set count of files that could be uploaded at the same time. * */ maxSimultaneousFilesUploads?: number; /** - * Get or set file size metrics how to be shown files size. + * Get or set file size metrics how to be shown files size. * */ fileSizeMetric?: any; /** - * UniqueId of the control - should not be changed by developer. Set from server-side wrapper. + * UniqueId of the control - should not be changed by developer. Set from server-side wrapper. * */ controlId?: string; /** - * The number of digits after the decimal point. + * The number of digits after the decimal point. * */ fileSizeDecimalDisplay?: number; /** - * Maximum size(in bytes) allowed for the file to be uploaded. If it is set to null or -1 there is no limitation otherwise if the size(of the selected file) exceeds this value it is not allowed to be uploaded. This option is used for validation only on client side and only if the browser supports HTML5 file API and share information about the file size + * Maximum size(in bytes) allowed for the file to be uploaded. If it is set to null or -1 there is no limitation otherwise if the size(of the selected file) exceeds this value it is not allowed to be uploaded. This option is used for validation only on client side and only if the browser supports HTML5 file API and share information about the file size */ maxFileSize?: any; /** - * Defines the name of the file upload selecting event. Fired when browse button is pressed. + * Defines the name of the file upload selecting event. Fired when browse button is pressed. * Return false in order to cancel selecting file. * Function takes arguments evt and ui. * Use ui.owner in order to access the igUpload widget object. @@ -79793,7 +79793,7 @@ interface IgUpload { fileSelecting?: FileSelectingEvent; /** - * Defines the name of the file upload selected event. Fired when file is selected from browse dialog. + * Defines the name of the file upload selected event. Fired when file is selected from browse dialog. * Return false in order to cancel uploading file. * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file @@ -79803,7 +79803,7 @@ interface IgUpload { fileSelected?: FileSelectedEvent; /** - * Defines the name of the file uploading event. Fired every time when fileuploader get status for the upload. + * Defines the name of the file uploading event. Fired every time when fileuploader get status for the upload. * Return false in order to cancel uploading file. * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file @@ -79817,7 +79817,7 @@ interface IgUpload { fileUploading?: FileUploadingEvent; /** - * Defines the name of the uploaded event. Fired when the file is uploaded + * Defines the name of the uploaded event. Fired when the file is uploaded * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file * Use ui.filePath to get the name of the uploaded file @@ -79828,7 +79828,7 @@ interface IgUpload { fileUploaded?: FileUploadedEvent; /** - * Defines the name of the file upload cancel event. Fired when the server responses that the file is canceled. + * Defines the name of the file upload cancel event. Fired when the server responses that the file is canceled. * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file * Use ui.filePath to get the name of the uploaded file @@ -79840,14 +79840,14 @@ interface IgUpload { fileUploadAborted?: FileUploadAbortedEvent; /** - * Defines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. + * Defines the name of the cancel all button event click. Fired when cancel all button in summary is clicked. Fired only in multiple upload mode. * Function takes arguments evt and ui. * Use ui.owner in order to access the igUpload widget object. */ cancelAllClicked?: CancelAllClickedEvent; /** - * Defines the name of the file upload error event. Fired when error is occurred. + * Defines the name of the file upload error event. Fired when error is occurred. * Function takes arguments evt and ui. * Use ui.errorCode to get current errorCode * Use ui.fileId to get identifier of the file for which the event is fired(after that it can be used API function getFileInfo). NOTE: It is possible to be null in some cases: try to drop multiple files when mode is single , check maximum allowed uploading files fails or check for count of maximum allowed simultaneous files upload fails. @@ -79859,7 +79859,7 @@ interface IgUpload { onError?: OnErrorEvent; /** - * It is fired when validating file extensions + * It is fired when validating file extensions * Function takes arguments evt and ui. * Use ui.fileName to get the full file name * Use ui.fileExtension to get file extension @@ -79868,7 +79868,7 @@ interface IgUpload { fileExtensionsValidating?: FileExtensionsValidatingEvent; /** - * It is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API + * It is fired when event onload(of XmlHttpRequest) is fired. This event will be fired only if the browser supports HTML5 file API * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file * Use ui.xhr to get reference to the original XMLHttpRequest object @@ -79878,7 +79878,7 @@ interface IgUpload { onXHRLoad?: OnXHRLoadEvent; /** - * It is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. + * It is fired before submitting to the server the uploading file(and its additional data if any). It could be used to append additional data fields to the FormData object(if the browser supports HTML5 file API - like newest Chrome, Firefox, IE11+). If the browser does not support HTML5 file API(IE10 and older) it could be added these data fields(as hidden input fields) to the form. Use the public API function addDataFields. * Function takes arguments evt and ui. * Use ui.fileId to get unique identifier of the file * Use ui.fileInfo to get reference to the fileInfo object - containing information for the fileName, fileSize, serverMessage, etc. @@ -79889,28 +79889,28 @@ interface IgUpload { onFormDataSubmit?: OnFormDataSubmitEvent; /** - * Option for igUpload + * Option for igUpload */ [optionName: string]: any; } interface IgUploadMethods { /** - * Return jquery object of fileupload container - html DOM element + * Return jquery object of fileupload container - html DOM element */ container(): void; /** - * Returns the current widget element + * Returns the current widget element */ widget(): void; /** - * Hide finished files + * Hide finished files */ clearAll(): void; /** - * Append additional data field to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server + * Append additional data field to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server * * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server * @param field Data field that should be appended to the formData. The object has 2 properties - value and name. If the browser supports HTML5 the data field is appended to the formData object. Otherwise it is appended as input hidden field to the @@ -79918,7 +79918,7 @@ interface IgUploadMethods { addDataField(formData: Object, field: Object): void; /** - * Append additional data fields to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server + * Append additional data fields to formData(before submitting it to the server). Usually this function is used in the handler of the event onFormDataSubmit. If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server * * @param formData If the browser supports HTML5 file API formData is instance of FormData, otherwise(like IE10 and older) formData is jQuery representation of the that should be submitted to the server * @param fields Array of data fields that should be appended to the formData. Each data field is object with 2 properties - value and name. If the browser supports HTML5 these data fields are added to the formData. Otherwise each of these data field is appended as input hidden field to the @@ -79926,37 +79926,37 @@ interface IgUploadMethods { addDataFields(formData: Object, fields: any[]): void; /** - * Start uploading file as submitting form with the specified formNumber. + * Start uploading file as submitting form with the specified formNumber. * * @param formNumber id of the upload form */ startUpload(formNumber: number): void; /** - * Cancel upload for the specified file id - * formNumber - id of the file to be canceled + * Cancel upload for the specified file id + * formNumber - id of the file to be canceled * * @param formNumber id of the form which should be cancelled */ cancelUpload(formNumber: number): void; /** - * Destroy the widget + * Destroy the widget */ destroy(): void; /** - * Returns the information about uploading files - all files uploaded/uploading/pending + * Returns the information about uploading files - all files uploaded/uploading/pending */ getFileInfoData(): Object; /** - * Cancel all uploading and pending files + * Cancel all uploading and pending files */ cancelAll(): void; /** - * Returns the information about the file by specified file identifier. It could be file which is uploading/uploaded or uploading is not started. If there isn"t file with the specified file id returns null + * Returns the information about the file by specified file identifier. It could be file which is uploading/uploaded or uploading is not started. If there isn"t file with the specified file id returns null * * @param fileIndex unique identifier of the file */ @@ -80808,7 +80808,7 @@ interface JQuery { } interface IgValidatorField { /** - * Gets the target element (input or control target) to be validated. This field setting is required. + * Gets the target element (input or control target) to be validated. This field setting is required. * * * Valid values: @@ -80818,7 +80818,7 @@ interface IgValidatorField { selector?: string|Object; /** - * Option for IgValidatorField + * Option for IgValidatorField */ [optionName: string]: any; } @@ -80829,12 +80829,12 @@ interface ValidatingEvent { interface ValidatingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get current value in target. + * Used to get current value in target. */ value?: any; } @@ -80845,22 +80845,22 @@ interface ValidatedEvent { interface ValidatedEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get current value in target. + * Used to get current value in target. */ value?: any; /** - * Used to determine the outcome of the validation. + * Used to determine the outcome of the validation. */ valid?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; } @@ -80871,22 +80871,22 @@ interface SuccessEvent { interface SuccessEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get current value in target. + * Used to get current value in target. */ value?: any; /** - * Used to determine the outcome of the validation. + * Used to determine the outcome of the validation. */ valid?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; } @@ -80897,22 +80897,22 @@ interface ErrorEvent { interface ErrorEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get current value in target. + * Used to get current value in target. */ value?: any; /** - * Used to determine the outcome of the validation. + * Used to determine the outcome of the validation. */ valid?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; } @@ -80923,17 +80923,17 @@ interface ErrorShowingEvent { interface ErrorShowingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -80944,17 +80944,17 @@ interface ErrorHidingEvent { interface ErrorHidingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -80965,17 +80965,17 @@ interface ErrorShownEvent { interface ErrorShownEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -80986,17 +80986,17 @@ interface ErrorHiddenEvent { interface ErrorHiddenEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -81007,17 +81007,17 @@ interface SuccessShowingEvent { interface SuccessShowingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -81028,17 +81028,17 @@ interface SuccessHidingEvent { interface SuccessHidingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -81049,17 +81049,17 @@ interface SuccessShownEvent { interface SuccessShownEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -81070,17 +81070,17 @@ interface SuccessHiddenEvent { interface SuccessHiddenEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get text of message. + * Used to get text of message. */ message?: any; /** - * Used to get reference to the target of the message. + * Used to get reference to the target of the message. */ target?: any; } @@ -81091,12 +81091,12 @@ interface FormValidatingEvent { interface FormValidatingEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get reference of the event target form. + * Used to get reference of the event target form. */ target?: any; } @@ -81107,17 +81107,17 @@ interface FormValidatedEvent { interface FormValidatedEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get reference of the event target form. + * Used to get reference of the event target form. */ target?: any; /** - * Used to determine the outcome of the validation. + * Used to determine the outcome of the validation. */ valid?: any; } @@ -81128,12 +81128,12 @@ interface FormErrorEvent { interface FormErrorEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get reference of the event target form. + * Used to get reference of the event target form. */ target?: any; } @@ -81144,19 +81144,19 @@ interface FormSuccessEvent { interface FormSuccessEventUIParam { /** - * Used to get reference to the igValidator widget. + * Used to get reference to the igValidator widget. */ owner?: any; /** - * Used to get reference of the event target form. + * Used to get reference of the event target form. */ target?: any; } interface IgValidator { /** - * Gets/Sets whether validation is triggered when the text in editor changes. + * Gets/Sets whether validation is triggered when the text in editor changes. * Note that this is more appropriate for selection controls such as checkbox, combo or rating. * As it can cause excessive messages with text-based fields, the initail validation can be delayed via the [threshold](ui.igvalidator#options:threshold) option. * @@ -81164,20 +81164,20 @@ interface IgValidator { onchange?: boolean; /** - * Gets/Sets whether validation is triggered when the editor loses focus. + * Gets/Sets whether validation is triggered when the editor loses focus. * */ onblur?: boolean; /** - * Gets/Sets whether validation is triggered when a form containing validation targets is submitting. If any of the validations fail, the submit action will be prevented. + * Gets/Sets whether validation is triggered when a form containing validation targets is submitting. If any of the validations fail, the submit action will be prevented. * Note that this doesn't apply to the native JavaScript submit function, but will handle the jQuery equivalent and the browser default action. * */ onsubmit?: boolean; /** - * Gets/Sets option to validate if a value was entered (not empty text, selected item, etc.) + * Gets/Sets option to validate if a value was entered (not empty text, selected item, etc.) * * * Valid values: @@ -81187,7 +81187,7 @@ interface IgValidator { required?: boolean|Object; /** - * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. + * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. * * * @@ -81198,7 +81198,7 @@ interface IgValidator { number?: boolean|Object; /** - * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. + * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. * * * @@ -81209,7 +81209,7 @@ interface IgValidator { date?: boolean|Object; /** - * Gets/Sets email validation rule options. Uses a RegExp defined in the "$.ui.igValidator.defaults" object. + * Gets/Sets email validation rule options. Uses a RegExp defined in the "$.ui.igValidator.defaults" object. * * * Valid values: @@ -81219,7 +81219,7 @@ interface IgValidator { email?: boolean|Object; /** - * Gets/Sets a minimum and/or maximum length of text or number of selected items. Null or 0 values are ignored. + * Gets/Sets a minimum and/or maximum length of text or number of selected items. Null or 0 values are ignored. * * * Valid values: @@ -81229,7 +81229,7 @@ interface IgValidator { lengthRange?: Array|Object; /** - * Gets/Sets a minimum and/or maximum value. Null values are ignored. + * Gets/Sets a minimum and/or maximum value. Null values are ignored. * * * Valid values: @@ -81239,7 +81239,7 @@ interface IgValidator { valueRange?: Array|Object; /** - * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. + * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. * * * @@ -81250,7 +81250,7 @@ interface IgValidator { creditCard?: boolean|Object; /** - * Gets/Sets regular expression validation rule options. + * Gets/Sets regular expression validation rule options. * * * Valid values: @@ -81260,32 +81260,32 @@ interface IgValidator { pattern?: string|Object; /** - * Gets/Sets a custom jQuery element to be used for validation messages. That inner HTML of the target is modified, can be a SPAN, LABEL or DIV. + * Gets/Sets a custom jQuery element to be used for validation messages. That inner HTML of the target is modified, can be a SPAN, LABEL or DIV. * */ messageTarget?: Element; /** - * Gets/Sets text for an error message to be used if none is set for the particular rule. Overrides default rule-specific error messages. + * Gets/Sets text for an error message to be used if none is set for the particular rule. Overrides default rule-specific error messages. * */ errorMessage?: string; /** - * Gets/Sets text for a success message. Note that since there is no default, setting this message will enable showing success indication. + * Gets/Sets text for a success message. Note that since there is no default, setting this message will enable showing success indication. * */ successMessage?: string; /** - * Gets/Sets validation minimum input length. Validation won't be triggered for input before that value is reached on change and focus loss. + * Gets/Sets validation minimum input length. Validation won't be triggered for input before that value is reached on change and focus loss. * Note: This will not affect required fields on form submit. * */ threshold?: number; /** - * Gets/Sets a requirement for the value in this field to be the same as another input element or editor control. + * Gets/Sets a requirement for the value in this field to be the same as another input element or editor control. * * * Valid values: @@ -81295,7 +81295,7 @@ interface IgValidator { equalTo?: string|Object; /** - * Gets/Sets a custom function to perform validation. Use 'this' to reference the calling validator and the value and optional field settings arguments to determine and return the state of the field. + * Gets/Sets a custom function to perform validation. Use 'this' to reference the calling validator and the value and optional field settings arguments to determine and return the state of the field. * * * Valid values: @@ -81306,34 +81306,34 @@ interface IgValidator { custom?: Function|string|Object; /** - * Gets a list of target field items describing each with validation options and a required selector. Fields can contain any of the validation rules and triggers but not other fields or event handlers. + * Gets a list of target field items describing each with validation options and a required selector. Fields can contain any of the validation rules and triggers but not other fields or event handlers. * Applicable options are also inherited from the global control configuration if not set. * */ fields?: IgValidatorField[]; /** - * Gets/Sets the options for the [igNotifier](ui.ignotifier#options) used to show error messages. + * Gets/Sets the options for the [igNotifier](ui.ignotifier#options) used to show error messages. * */ notificationOptions?: any; /** - * Gets/Sets the option to show an asterisks indication next to required fields. + * Gets/Sets the option to show an asterisks indication next to required fields. * Note: Indicators are not supported on grouped controls such as checkbox or radio button sets and the igRating control. * */ requiredIndication?: boolean; /** - * Gets/Sets the option to show a label indication next to optional fields. + * Gets/Sets the option to show a label indication next to optional fields. * Note: Indicators are not supported on grouped controls such as checkbox or radio button sets and the igRating control. * */ optionalIndication?: boolean; /** - * Event which is raised on validation before default validation logic is applied. + * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. * * Function takes arguments evt and ui. @@ -81344,7 +81344,7 @@ interface IgValidator { validating?: ValidatingEvent; /** - * Event which is raised after value was validated but before any action takes effect. + * Event which is raised after value was validated but before any action takes effect. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81357,7 +81357,7 @@ interface IgValidator { validated?: ValidatedEvent; /** - * Event raised for valid field after value was validated but before any action takes effect. + * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. * * Use ui.owner to get reference to the igValidator widget. @@ -81369,7 +81369,7 @@ interface IgValidator { success?: SuccessEvent; /** - * Event raised for invalid field after value was validated but before any action takes effect. + * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. * * Use ui.owner to get reference to the igValidator widget. @@ -81382,7 +81382,7 @@ interface IgValidator { error?: ErrorEvent; /** - * Event which is raised before error message is displayed. + * Event which is raised before error message is displayed. * Return false in order to prevent error message display. * * Function takes arguments evt and ui. @@ -81394,7 +81394,7 @@ interface IgValidator { errorShowing?: ErrorShowingEvent; /** - * Event which is raised before error message is hidden. + * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. * * Function takes arguments evt and ui. @@ -81406,7 +81406,7 @@ interface IgValidator { errorHiding?: ErrorHidingEvent; /** - * Event which is raised after error message was displayed. + * Event which is raised after error message was displayed. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81417,7 +81417,7 @@ interface IgValidator { errorShown?: ErrorShownEvent; /** - * Event which is raised after error message was hidden. + * Event which is raised after error message was hidden. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81428,7 +81428,7 @@ interface IgValidator { errorHidden?: ErrorHiddenEvent; /** - * Event which is raised before success message is displayed. + * Event which is raised before success message is displayed. * Return false in order to prevent success message display. * * Function takes arguments evt and ui. @@ -81440,7 +81440,7 @@ interface IgValidator { successShowing?: SuccessShowingEvent; /** - * Event which is raised before success message is hidden. + * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. * * Function takes arguments evt and ui. @@ -81452,7 +81452,7 @@ interface IgValidator { successHiding?: SuccessHidingEvent; /** - * Event which is raised after success message was displayed. + * Event which is raised after success message was displayed. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81463,7 +81463,7 @@ interface IgValidator { successShown?: SuccessShownEvent; /** - * Event which is raised after success message was hidden. + * Event which is raised after success message was hidden. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81474,7 +81474,7 @@ interface IgValidator { successHidden?: SuccessHiddenEvent; /** - * Event triggered on Validator instance level before handling a form submit event. + * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. * * Function takes arguments evt and ui. @@ -81484,7 +81484,7 @@ interface IgValidator { formValidating?: FormValidatingEvent; /** - * Event triggered on Validator instance level after validation on form submit event.. + * Event triggered on Validator instance level after validation on form submit event.. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81494,7 +81494,7 @@ interface IgValidator { formValidated?: FormValidatedEvent; /** - * Event triggered on Validator instance level after failed validation on form submit event. + * Event triggered on Validator instance level after failed validation on form submit event. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81503,7 +81503,7 @@ interface IgValidator { formError?: FormErrorEvent; /** - * Event triggered on Validator instance level after successful validation on form submit event. + * Event triggered on Validator instance level after successful validation on form submit event. * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. @@ -81512,72 +81512,72 @@ interface IgValidator { formSuccess?: FormSuccessEvent; /** - * Option for igValidator + * Option for igValidator */ [optionName: string]: any; } interface IgValidatorMethods { /** - * Trigger validation and show errors for invalid fields. + * Trigger validation and show errors for invalid fields. * * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. */ validate(field?: Object): boolean; /** - * Trigger validation but do not display error messages. + * Trigger validation but do not display error messages. * * @param field Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields. */ isValid(field?: Object): boolean; /** - * Hide any possible message(s) (either messageTarget or igNotifier). - * Note: When the validator has a fields colleciton, not passing a field will hide messages on all fields. + * Hide any possible message(s) (either messageTarget or igNotifier). + * Note: When the validator has a fields colleciton, not passing a field will hide messages on all fields. * * @param field Optional field object, its selector or zero-based index to hide message for. */ hide(field?: Object): void; /** - * Gets all current error messages for invalid field(s). Note that this method does not valdiate and states and messages are only updated on validation, so - * this can be used on formValidated event or after validate/isValid method calls. + * Gets all current error messages for invalid field(s). Note that this method does not valdiate and states and messages are only updated on validation, so + * this can be used on formValidated event or after validate/isValid method calls. * * @param field Optional field object, selector or zero-based index for a single field to get error message for. */ getErrorMessages(field?: Object): any[]; /** - * Check for currently displayed message(s). Takes an optional field. - * Note: When the validator has a fields colleciton, not passing a field will return a cumulative true even if just one field has a visible message. + * Check for currently displayed message(s). Takes an optional field. + * Note: When the validator has a fields colleciton, not passing a field will return a cumulative true even if just one field has a visible message. * * @param field Optional field object, selector or zero-based index for a single field to get error message for. */ isMessageDisplayed(field?: Object): boolean; /** - * Gets the notifier for the igValidator or for a single filed. + * Gets the notifier for the igValidator or for a single filed. * * @param field Optional field object, its selector or zero-based index to get notifier for. */ notifier(field?: Object): Object; /** - * Adds an new input to the fields collection and initializes it with the validator. Note: Additional fields are only accepted if the validator has been created with the collection. + * Adds an new input to the fields collection and initializes it with the validator. Note: Additional fields are only accepted if the validator has been created with the collection. * * @param field An object with the field selector and options. */ addField(field: Object): void; /** - * Removes an input from the fields collection. + * Removes an input from the fields collection. * * @param field The field object to remove, its zero-based index or selector. */ removeField(field: Object): void; /** - * Updates a field in the validator collection. Used to reinitialize field in case a control has been created after the validator or to pass in new options. + * Updates a field in the validator collection. Used to reinitialize field in case a control has been created after the validator or to pass in new options. * * @param field The field object to update, its zero-based index or selector. * @param fieldOptions New options to apply to the field. @@ -81585,7 +81585,7 @@ interface IgValidatorMethods { updateField(field: Object, fieldOptions?: Object): void; /** - * Destroys the validator widget. + * Destroys the validator widget. */ destroy(): void; } @@ -81600,7 +81600,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81695,7 +81695,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81728,7 +81728,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81799,7 +81799,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81832,7 +81832,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81865,7 +81865,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -81923,8 +81923,8 @@ declare namespace Infragistics { /** * Based on ASP.NET CreditCardAttribute check, - * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs - * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm + * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs + * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm * * @param options * @param value @@ -81933,7 +81933,7 @@ declare namespace Infragistics { /** * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. + * Only used when there's no errorMessage option available through getRuleMessage. * * @param options */ @@ -82681,283 +82681,283 @@ interface JQuery { } interface IgVideoPlayerBookmark { /** - * Gets/Sets where the bookmark will be positioned. Should be between 0 and movie duration in seconds. + * Gets/Sets where the bookmark will be positioned. Should be between 0 and movie duration in seconds. * */ time?: number; /** - * Gets/Sets bookmark title. It is shown as tooltip on hover. + * Gets/Sets bookmark title. It is shown as tooltip on hover. * */ title?: string; /** - * Gets/Sets whether the bookmark is disabled or not. + * Gets/Sets whether the bookmark is disabled or not. * */ disabled?: boolean; /** - * Option for IgVideoPlayerBookmark + * Option for IgVideoPlayerBookmark */ [optionName: string]: any; } interface IgVideoPlayerRelatedVideo { /** - * Gets/Sets the URL of the related video image. + * Gets/Sets the URL of the related video image. * */ imageUrl?: string; /** - * Gets/Sets the title of the video. + * Gets/Sets the title of the video. * */ title?: string; /** - * Gets/Sets the width of the related video image. + * Gets/Sets the width of the related video image. * */ width?: number; /** - * Gets/Sets the height of the related video image. + * Gets/Sets the height of the related video image. * */ height?: number; /** - * Gets/Sets a link to a page that will play the related video. It will be opened in a new window. If there are sources also, the link property has a priority. + * Gets/Sets a link to a page that will play the related video. It will be opened in a new window. If there are sources also, the link property has a priority. * */ link?: string; /** - * Gets/Sets the sources of the related video. + * Gets/Sets the sources of the related video. * */ sources?: any[]; /** - * Gets/Sets custom CSS class to be applied on the related video element. + * Gets/Sets custom CSS class to be applied on the related video element. * */ css?: string; /** - * Option for IgVideoPlayerRelatedVideo + * Option for IgVideoPlayerRelatedVideo */ [optionName: string]: any; } interface IgVideoPlayerBanner { /** - * Gets/Sets the banner image url. + * Gets/Sets the banner image url. * */ imageUrl?: string; /** - * Gets/Sets an array of numbers. Each number specifies on which second in the movie the banner will pop. + * Gets/Sets an array of numbers. Each number specifies on which second in the movie the banner will pop. * */ times?: any[]; /** - * Gets/Sets whether the user will be able to close the banner or not. + * Gets/Sets whether the user will be able to close the banner or not. * */ closeBanner?: boolean; /** - * Gets/Sets whether to apply animation effects when showing or hiding the banner. If set to true, the animation is played for banner.duration in milliseconds. + * Gets/Sets whether to apply animation effects when showing or hiding the banner. If set to true, the animation is played for banner.duration in milliseconds. * */ animate?: boolean; /** - * Gets/Sets whether the banner is visible or not. + * Gets/Sets whether the banner is visible or not. * */ visible?: boolean; /** - * Gets/Sets the banner animation duration. + * Gets/Sets the banner animation duration. * */ duration?: number; /** - * Gets/Sets whether to automatically hide the banner. If set to true, the banner is hidden after [hidedelay](ui.igvideoplayer#options:banners.hidedelay) in milliseconds. + * Gets/Sets whether to automatically hide the banner. If set to true, the banner is hidden after [hidedelay](ui.igvideoplayer#options:banners.hidedelay) in milliseconds. * */ autohide?: boolean; /** - * Gets/Sets the banner autohide delay in milliseconds. It is taken into account only if the banner.autohide option is set to true. + * Gets/Sets the banner autohide delay in milliseconds. It is taken into account only if the banner.autohide option is set to true. * */ hidedelay?: number; /** - * Gets/Sets the banner link that will open in new window. + * Gets/Sets the banner link that will open in new window. * */ link?: string; /** - * Gets/Sets the banner width + * Gets/Sets the banner width * */ width?: number|string; /** - * Gets/Sets the banner height + * Gets/Sets the banner height * */ height?: number|string; /** - * Gets/Sets the banner specific css class, that will be applied on the banner grid. + * Gets/Sets the banner specific css class, that will be applied on the banner grid. * */ css?: string; /** - * Option for IgVideoPlayerBanner + * Option for IgVideoPlayerBanner */ [optionName: string]: any; } interface IgVideoPlayerCommercialsLinkedCommercial { /** - * Gets/Sets the sources of the linked commercial video. + * Gets/Sets the sources of the linked commercial video. * */ sources?: any[]; /** - * Gets/Sets the second in the video at which the linked commercial should play. + * Gets/Sets the second in the video at which the linked commercial should play. * */ startTime?: number; /** - * Gets/Sets the link to open on linked commercial click. + * Gets/Sets the link to open on linked commercial click. * */ link?: string; /** - * Gets/Sets the tooltip for the linked commercial bookmark. + * Gets/Sets the tooltip for the linked commercial bookmark. * */ title?: string; /** - * Option for IgVideoPlayerCommercialsLinkedCommercial + * Option for IgVideoPlayerCommercialsLinkedCommercial */ [optionName: string]: any; } interface IgVideoPlayerCommercialsEmbeddedCommercial { /** - * Gets/Sets the start second of the embedded commercial. + * Gets/Sets the start second of the embedded commercial. * */ startTime?: number; /** - * Gets/Sets the end second of the embedded commercial. + * Gets/Sets the end second of the embedded commercial. * */ endTime?: number; /** - * Gets/Sets the sponsored link of the embedded commercial. + * Gets/Sets the sponsored link of the embedded commercial. * */ link?: string; /** - * Gets/Sets the tooltip for the bookmark of the embedded commercial. + * Gets/Sets the tooltip for the bookmark of the embedded commercial. * */ title?: string; /** - * Option for IgVideoPlayerCommercialsEmbeddedCommercial + * Option for IgVideoPlayerCommercialsEmbeddedCommercial */ [optionName: string]: any; } interface IgVideoPlayerCommercialsAdMessage { /** - * Gets/Sets whether to apply an animation effect when showing or hiding the ad message. If set to true, the animation is played for [animationDuration](ui.igvideoplayer#options:commercials.adMessage.animationDuration) in milliseconds. + * Gets/Sets whether to apply an animation effect when showing or hiding the ad message. If set to true, the animation is played for [animationDuration](ui.igvideoplayer#options:commercials.adMessage.animationDuration) in milliseconds. * */ animate?: boolean; /** - * Gets/Sets the ad message auto hide of the commercial. + * Gets/Sets the ad message auto hide of the commercial. * */ autoHide?: boolean; /** - * Gets/Sets the ad message hide delay. + * Gets/Sets the ad message hide delay. * */ hideDelay?: number; /** - * Gets/Sets the ad message animation duration of the commercial. + * Gets/Sets the ad message animation duration of the commercial. * */ animationDuration?: number; /** - * Option for IgVideoPlayerCommercialsAdMessage + * Option for IgVideoPlayerCommercialsAdMessage */ [optionName: string]: any; } interface IgVideoPlayerCommercials { /** - * Gets/Sets an array of linked commercial objects. A linked commercial is a separate video file that will be played in the specified position of the original movie clip by [startTime](ui.igvideoplayer#options:commercials.linkedCommercials.startTime). This feature is useful if you have frequently changing outside commercial sources. + * Gets/Sets an array of linked commercial objects. A linked commercial is a separate video file that will be played in the specified position of the original movie clip by [startTime](ui.igvideoplayer#options:commercials.linkedCommercials.startTime). This feature is useful if you have frequently changing outside commercial sources. * */ linkedCommercials?: IgVideoPlayerCommercialsLinkedCommercial[]; /** - * Gets/Sets an array of embedded commercials objects. An embedded commercial is an ad that is contained in the original video file. It is suitable when you want to mark some sections of the video as commercials. + * Gets/Sets an array of embedded commercials objects. An embedded commercial is an ad that is contained in the original video file. It is suitable when you want to mark some sections of the video as commercials. * */ embeddedCommercials?: IgVideoPlayerCommercialsEmbeddedCommercial[]; /** - * Gets/Sets whether the commercials will play againg during the repetitive video plays. + * Gets/Sets whether the commercials will play againg during the repetitive video plays. * */ alwaysPlayCommercials?: boolean; /** - * Gets/Sets whether to show commercial locations or not. + * Gets/Sets whether to show commercial locations or not. * */ showBookmarks?: boolean; /** - * Customizes the ad message settings of the commercial. Ad message shows the duration of the commercial and pops up when the commercial starts playing. + * Customizes the ad message settings of the commercial. Ad message shows the duration of the commercial and pops up when the commercial starts playing. * */ adMessage?: IgVideoPlayerCommercialsAdMessage; /** - * Option for IgVideoPlayerCommercials + * Option for IgVideoPlayerCommercials */ [optionName: string]: any; } @@ -82968,12 +82968,12 @@ interface EndedEvent { interface EndedEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get the video duration in seconds. + * Used to get the video duration in seconds. */ duration?: any; } @@ -82984,12 +82984,12 @@ interface PlayingEvent { interface PlayingEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get the video duration in seconds. + * Used to get the video duration in seconds. */ duration?: any; } @@ -83000,12 +83000,12 @@ interface PausedEvent { interface PausedEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get the video duration in seconds. + * Used to get the video duration in seconds. */ duration?: any; } @@ -83016,12 +83016,12 @@ interface BufferingEvent { interface BufferingEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get buffered percentage. + * Used to get buffered percentage. */ buffered?: any; } @@ -83032,17 +83032,17 @@ interface ProgressEvent { interface ProgressEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get current position in the video at which the event was fired. + * Used to get current position in the video at which the event was fired. */ currentTime?: any; /** - * Used to get the video duration in seconds. + * Used to get the video duration in seconds. */ duration?: any; } @@ -83053,17 +83053,17 @@ interface WaitingEvent { interface WaitingEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; /** - * Used to get current position in the video at which the event was fired. + * Used to get current position in the video at which the event was fired. */ currentTime?: any; /** - * Used to get the video duration in seconds. + * Used to get the video duration in seconds. */ duration?: any; } @@ -83074,7 +83074,7 @@ interface EnterFullScreenEvent { interface EnterFullScreenEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; } @@ -83085,7 +83085,7 @@ interface ExitFullScreenEvent { interface ExitFullScreenEventUIParam { /** - * Used to get the url of the playing video. + * Used to get the url of the playing video. */ source?: any; } @@ -83096,12 +83096,12 @@ interface RelatedVideoClickEvent { interface RelatedVideoClickEventUIParam { /** - * Used to get the relatedVideo object from the relatedVideos array. + * Used to get the relatedVideo object from the relatedVideos array. */ relatedVideo?: any; /** - * Used to get the relatedVideo html element in the DOM. + * Used to get the relatedVideo html element in the DOM. */ relatedVideoElement?: any; } @@ -83112,17 +83112,17 @@ interface BannerVisibleEvent { interface BannerVisibleEventUIParam { /** - * Used to get the banner index in the banners array. + * Used to get the banner index in the banners array. */ index?: any; /** - * Used to get the banner object from the banners array. + * Used to get the banner object from the banners array. */ banner?: any; /** - * Used to get the banner html element in the DOM. + * Used to get the banner html element in the DOM. */ bannerElement?: any; } @@ -83133,17 +83133,17 @@ interface BannerHiddenEvent { interface BannerHiddenEventUIParam { /** - * Used to get the banner index in the banners array. + * Used to get the banner index in the banners array. */ index?: any; /** - * Used to get the banner object from the banners array. + * Used to get the banner object from the banners array. */ banner?: any; /** - * Used to get the banner html element in the DOM. + * Used to get the banner html element in the DOM. */ bannerElement?: any; } @@ -83154,140 +83154,140 @@ interface BannerClickEvent { interface BannerClickEventUIParam { /** - * Used to get the banner html element in the DOM. + * Used to get the banner html element in the DOM. */ bannerElement?: any; } interface IgVideoPlayer { /** - * Gets/Sets a list of video sources to choose from. Best coded/format is automatically detected by the control. Supported types are depending on the browser and could be one of the following mov, mp4, webm, ogg. + * Gets/Sets a list of video sources to choose from. Best coded/format is automatically detected by the control. Supported types are depending on the browser and could be one of the following mov, mp4, webm, ogg. * */ sources?: any[]; /** - * Gets/Sets the width of the control. By default null will stretch the control to fit data, if no other widths are defined. + * Gets/Sets the width of the control. By default null will stretch the control to fit data, if no other widths are defined. * */ width?: string|number; /** - * Gets/Sets the height of the control. By default null will stretch the control to fit data, if no other heights are defined. + * Gets/Sets the height of the control. By default null will stretch the control to fit data, if no other heights are defined. * */ height?: string|number; /** - * Gets/Sets a URL to an image to show, when no video data is available. + * Gets/Sets a URL to an image to show, when no video data is available. * */ posterUrl?: string; /** - * Gets/Sets whether to preload load initial data for duration of video. If true it may start buffering the video, but this highly depends on the specific browser implementation. + * Gets/Sets whether to preload load initial data for duration of video. If true it may start buffering the video, but this highly depends on the specific browser implementation. * */ preload?: boolean; /** - * Gets/Sets whether the video should start playing immediately after the control is loaded. + * Gets/Sets whether the video should start playing immediately after the control is loaded. * */ autoplay?: boolean; /** - * Gets/Sets whether player controls will auto hide when video is not hovered. This is applicable only when Infragistics playback controls are used. + * Gets/Sets whether player controls will auto hide when video is not hovered. This is applicable only when Infragistics playback controls are used. * */ autohide?: boolean; /** - * Gets/Sets volume slider auto hide delay. This is applicable only when Infragistics playback controls are used. + * Gets/Sets volume slider auto hide delay. This is applicable only when Infragistics playback controls are used. * */ volumeAutohideDelay?: number; /** - * Gets/Sets the center big button hide delay. + * Gets/Sets the center big button hide delay. * */ centerButtonHideDelay?: number; /** - * Gets/Sets whether the video to start again after it has ended. + * Gets/Sets whether the video to start again after it has ended. * */ loop?: boolean; /** - * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. + * Gets/Sets whether if you want to use the built in browser controls. By default player uses Infragistics playback controls. Note that you may have different look and feel across different browsers if you use the built in browser controls. * */ browserControls?: boolean; /** - * Gets/Sets whether the video player to be in full screen or not. This is not a pure full screen, because browsers do not allow that. It just sets 100% width and height to the control. + * Gets/Sets whether the video player to be in full screen or not. This is not a pure full screen, because browsers do not allow that. It just sets 100% width and height to the control. * */ fullscreen?: boolean; /** - * Gets/Sets the video volume. It can be between 0.0 and 1.0. + * Gets/Sets the video volume. It can be between 0.0 and 1.0. * */ volume?: number; /** - * Gets/Sets whether the video volume is muted. + * Gets/Sets whether the video volume is muted. * */ muted?: boolean; /** - * Gets/Sets video title. + * Gets/Sets video title. * */ title?: string; /** - * Gets/Sets whether the control seek tool tip will be shown when hovering the video progress bar. + * Gets/Sets whether the control seek tool tip will be shown when hovering the video progress bar. * */ showSeekTime?: boolean; /** - * Gets/Sets the format of the video progress label. You should use ${currentTime} to represent current playback position and ${duration} to represent video duration. + * Gets/Sets the format of the video progress label. You should use ${currentTime} to represent current playback position and ${duration} to represent video duration. * */ progressLabelFormat?: string; /** - * Gets/Sets an array of bookmarks that will be displayed in the video player control. + * Gets/Sets an array of bookmarks that will be displayed in the video player control. * */ bookmarks?: IgVideoPlayerBookmark[]; /** - * Gets/Sets an array of related videos that will be displayed when video playback has ended. + * Gets/Sets an array of related videos that will be displayed when video playback has ended. * */ relatedVideos?: IgVideoPlayerRelatedVideo[]; /** - * Gets/Sets an array of banner objects that will show the banners when the video clip is played. + * Gets/Sets an array of banner objects that will show the banners when the video clip is played. * */ banners?: IgVideoPlayerBanner[]; /** - * Gets/Sets an array of commercials objects that will be displayed when the video is playing. + * Gets/Sets an array of commercials objects that will be displayed when the video is playing. * */ commercials?: IgVideoPlayerCommercials; /** - * Occurs when video has ended. + * Occurs when video has ended. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83296,7 +83296,7 @@ interface IgVideoPlayer { ended?: EndedEvent; /** - * Occurs when video gets playing. + * Occurs when video gets playing. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83305,7 +83305,7 @@ interface IgVideoPlayer { playing?: PlayingEvent; /** - * Occurs when video is paused. + * Occurs when video is paused. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83314,7 +83314,7 @@ interface IgVideoPlayer { paused?: PausedEvent; /** - * Occurs when a chunk of data is buffered. + * Occurs when a chunk of data is buffered. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83323,7 +83323,7 @@ interface IgVideoPlayer { buffering?: BufferingEvent; /** - * Occurs when video has advanced the playback position. + * Occurs when video has advanced the playback position. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83333,7 +83333,7 @@ interface IgVideoPlayer { progress?: ProgressEvent; /** - * Occurs when igVideoPlayer is waiting for data from the server. + * Occurs when igVideoPlayer is waiting for data from the server. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83343,7 +83343,7 @@ interface IgVideoPlayer { waiting?: WaitingEvent; /** - * Occurs when the bookmark is hit. + * Occurs when the bookmark is hit. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83353,7 +83353,7 @@ interface IgVideoPlayer { bookmarkHit?: BookmarkHitEvent; /** - * Occurs when the bookmark is clicked. + * Occurs when the bookmark is clicked. * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -83362,7 +83362,7 @@ interface IgVideoPlayer { bookmarkClick?: BookmarkClickEvent; /** - * Occurs when igVideoPlayer enters full screen mode. + * Occurs when igVideoPlayer enters full screen mode. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83370,7 +83370,7 @@ interface IgVideoPlayer { enterFullScreen?: EnterFullScreenEvent; /** - * Occurs when igVideoPlayer exits full screen mode. + * Occurs when igVideoPlayer exits full screen mode. * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. @@ -83378,7 +83378,7 @@ interface IgVideoPlayer { exitFullScreen?: ExitFullScreenEvent; /** - * Occurs when related video is clicked. + * Occurs when related video is clicked. * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. @@ -83387,7 +83387,7 @@ interface IgVideoPlayer { relatedVideoClick?: RelatedVideoClickEvent; /** - * Defines the name of the player banner visible event. Fired when the banner has been displayed. + * Defines the name of the player banner visible event. Fired when the banner has been displayed. * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. @@ -83397,7 +83397,7 @@ interface IgVideoPlayer { bannerVisible?: BannerVisibleEvent; /** - * Occurs when the banner is hidden. + * Occurs when the banner is hidden. * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. @@ -83407,7 +83407,7 @@ interface IgVideoPlayer { bannerHidden?: BannerHiddenEvent; /** - * Occurs when the banner is clicked. + * Occurs when the banner is clicked. * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. @@ -83415,123 +83415,123 @@ interface IgVideoPlayer { bannerClick?: BannerClickEvent; /** - * Occurs when browser does not support HTML 5 video. + * Occurs when browser does not support HTML 5 video. */ browserNotSupported?: BrowserNotSupportedEvent; /** - * Option for igVideoPlayer + * Option for igVideoPlayer */ [optionName: string]: any; } interface IgVideoPlayerMethods { /** - * Returns the element on which the widget was instantiated + * Returns the element on which the widget was instantiated */ widget(): void; /** - * Hide the add message if shown. + * Hide the add message if shown. */ hideAdMessage(): void; /** - * Play a linked commercial for this video. + * Play a linked commercial for this video. * * @param commercial Specify the linked commercial to play. */ playCommercial(commercial: Object): void; /** - * Shows the ad banner, if there is such. + * Shows the ad banner, if there is such. * * @param index Specify the index of the banner from the banners array. */ showBanner(index: number): void; /** - * Hide the ad banner, if there is such. + * Hide the ad banner, if there is such. * * @param index Specify the index of the banner from the banners array. */ hideBanner(index: number): void; /** - * Resets the commercials, to be shown again. + * Resets the commercials, to be shown again. */ resetCommercialsShow(): void; /** - * Toggle control play state. If video is playing it will pause, if video is paused it will play. + * Toggle control play state. If video is playing it will pause, if video is paused it will play. */ togglePlay(): void; /** - * Start playing current loaded video if any. + * Start playing current loaded video if any. */ play(): void; /** - * Pause the currently playing video if any. + * Pause the currently playing video if any. */ pause(): void; /** - * Gets/Sets the current time of the playing video. + * Gets/Sets the current time of the playing video. * * @param val Specify the playback position in seconds to navigate to. */ currentTime(val: number): number; /** - * Get a screenshot of the current video frame. It returns a canvas object that you can position and show on the page. This depends on the browser support for canvas. + * Get a screenshot of the current video frame. It returns a canvas object that you can position and show on the page. This depends on the browser support for canvas. * * @param scaleFactor Specify scale factor between 0 and 1. */ screenshot(scaleFactor?: number): Object; /** - * Get whether the current browser supports video tag. + * Get whether the current browser supports video tag. */ supportsVideo(): boolean; /** - * Get whether the current browser supports H.264 codec. + * Get whether the current browser supports H.264 codec. */ supportsH264BaselineVideo(): boolean; /** - * Get whether the current browser supports Theora codec. + * Get whether the current browser supports Theora codec. */ supportsOggTheoraVideo(): boolean; /** - * Get whether the current browser supports WEBM codec. + * Get whether the current browser supports WEBM codec. */ supportsWebmVideo(): boolean; /** - * Returns whether the currently played video is paused. + * Returns whether the currently played video is paused. */ paused(): boolean; /** - * Get whether the current played video has ended. + * Get whether the current played video has ended. */ ended(): boolean; /** - * Get the current duration of the played video. It may be NaN if duration is still not loaded or the video is a live stream. + * Get the current duration of the played video. It may be NaN if duration is still not loaded or the video is a live stream. */ duration(): number; /** - * Get whether the player is seeking to find the new playback position specified. + * Get whether the player is seeking to find the new playback position specified. */ seeking(): boolean; /** - * Destroys the widget. + * Destroys the widget. */ destroy(): void; } @@ -84158,19 +84158,19 @@ interface JQuery { } interface IgZoombarDefaultZoomWindow { /** - * The left component of the zoom window in percentages. + * The left component of the zoom window in percentages. * */ left?: number; /** - * The width of the zoom window in percentages. + * The width of the zoom window in percentages. * */ width?: string; /** - * Option for IgZoombarDefaultZoomWindow + * Option for IgZoombarDefaultZoomWindow */ [optionName: string]: any; } @@ -84181,7 +84181,7 @@ interface ZoomChangingEvent { interface ZoomChangingEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84192,7 +84192,7 @@ interface ZoomChangedEvent { interface ZoomChangedEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84203,12 +84203,12 @@ interface ProviderCreatedEvent { interface ProviderCreatedEventUIParam { /** - * Used to get the reference the created provider + * Used to get the reference the created provider */ provider?: any; /** - * Used to get reference to igZoombar + * Used to get reference to igZoombar */ owner?: any; } @@ -84219,7 +84219,7 @@ interface WindowDragStartingEvent { interface WindowDragStartingEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84230,7 +84230,7 @@ interface WindowDragStartedEvent { interface WindowDragStartedEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84241,7 +84241,7 @@ interface WindowDraggingEvent { interface WindowDraggingEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84252,7 +84252,7 @@ interface WindowDragEndingEvent { interface WindowDragEndingEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84263,7 +84263,7 @@ interface WindowDragEndedEvent { interface WindowDragEndedEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } @@ -84274,27 +84274,27 @@ interface WindowResizingEvent { interface WindowResizingEventUIParam { /** - * Used to get reference to igZoombar. + * Used to get reference to igZoombar. */ owner?: any; } interface IgZoombar { /** - * Specifies a provider class which interfaces the widget that is being zoomed. + * Specifies a provider class which interfaces the widget that is being zoomed. * object Provider class to use. The provider should implement all methods in the $.ig.ZoombarProviderDefault class and is suggested to be extended from it. */ provider?: any; /** - * Specifies the element on which the widget the Zoombar is attached to is initialized. + * Specifies the element on which the widget the Zoombar is attached to is initialized. * object A valid jQuery object, the first element of which is that element. * */ target?: string|Object; /** - * Specifies how the target widget's clone is rendered inside the Zoombar. + * Specifies how the target widget's clone is rendered inside the Zoombar. * object A valid set of properties to initialize the clone with. * * @@ -84305,7 +84305,7 @@ interface IgZoombar { clone?: string|Object; /** - * Specifies the width of the Zoombar. + * Specifies the width of the Zoombar. * * * Valid values: @@ -84315,7 +84315,7 @@ interface IgZoombar { width?: string|number; /** - * Specifies the height of the Zoombar. + * Specifies the height of the Zoombar. * * * Valid values: @@ -84324,7 +84324,7 @@ interface IgZoombar { height?: number|string; /** - * Specifies when the zoom effect is applied. + * Specifies when the zoom effect is applied. * * * Valid values: @@ -84334,43 +84334,43 @@ interface IgZoombar { zoomAction?: string; /** - * Specifies the distance (in percents) the zoom window moves when the left or right scroll bar buttons are clicked. + * Specifies the distance (in percents) the zoom window moves when the left or right scroll bar buttons are clicked. * */ zoomWindowMoveDistance?: number; /** - * Specifies the default zoom in percentages. + * Specifies the default zoom in percentages. * */ defaultZoomWindow?: IgZoombarDefaultZoomWindow; /** - * The minimal width the zoom window can have in percentages. + * The minimal width the zoom window can have in percentages. * */ zoomWindowMinWidth?: number; /** - * Specifies the animation duration (in milliseconds) when hover style is applied or removed from elements. + * Specifies the animation duration (in milliseconds) when hover style is applied or removed from elements. * */ hoverStyleAnimationDuration?: number; /** - * Specifies the pan duration (in milliseconds) when the window changes position. Set to 0 for snap. + * Specifies the pan duration (in milliseconds) when the window changes position. Set to 0 for snap. * */ windowPanDuration?: number; /** - * Initial tabIndex for the Zoombar container elements. + * Initial tabIndex for the Zoombar container elements. * */ tabIndex?: number; /** - * Event fired before a zoom action is applied + * Event fired before a zoom action is applied * Function takes arguments evt and ui. * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target @@ -84381,7 +84381,7 @@ interface IgZoombar { zoomChanging?: ZoomChangingEvent; /** - * Event fired after a zoom action is applied. + * Event fired after a zoom action is applied. * Function takes arguments evt and ui. * Use ui.previousZoom.left to get the previous zoom window left position as a fraction of the absolute width of the target * Use ui.previousZoom.width to get the previous zoom window width as a fraction of the absolute width of the target @@ -84392,7 +84392,7 @@ interface IgZoombar { zoomChanged?: ZoomChangedEvent; /** - * Event fired after a provider is created based on the options.provider value. If an instance is passed as a value for the option the event won't fire. + * Event fired after a provider is created based on the options.provider value. If an instance is passed as a value for the option the event won't fire. * Use the event when utilizing a custom provider to assign options such as the zoomed widget's instance so that the provider's API is usable when igZoombar initializes its rendering. * Function takes arguments evt and ui. * Use ui.provider to get the reference the created provider @@ -84401,7 +84401,7 @@ interface IgZoombar { providerCreated?: ProviderCreatedEvent; /** - * Event fired when the user attempts to drag the zoom window. + * Event fired when the user attempts to drag the zoom window. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84410,7 +84410,7 @@ interface IgZoombar { windowDragStarting?: WindowDragStartingEvent; /** - * Event fired when the user starts dragging the zoom window. + * Event fired when the user starts dragging the zoom window. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84419,7 +84419,7 @@ interface IgZoombar { windowDragStarted?: WindowDragStartedEvent; /** - * Event fired when the user drags the zoom window. + * Event fired when the user drags the zoom window. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84428,7 +84428,7 @@ interface IgZoombar { windowDragging?: WindowDraggingEvent; /** - * Event fired when the user attemtps to stop dragging the zoom window. + * Event fired when the user attemtps to stop dragging the zoom window. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84437,7 +84437,7 @@ interface IgZoombar { windowDragEnding?: WindowDragEndingEvent; /** - * Event fired when the user stops dragging the zoom window. + * Event fired when the user stops dragging the zoom window. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84446,7 +84446,7 @@ interface IgZoombar { windowDragEnded?: WindowDragEndedEvent; /** - * Event fired when the user resizes the zoom window with the window"s handles. + * Event fired when the user resizes the zoom window with the window"s handles. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84455,7 +84455,7 @@ interface IgZoombar { windowResizing?: WindowResizingEvent; /** - * Event fired after the user resizes the zoom window with the window"s handles. + * Event fired after the user resizes the zoom window with the window"s handles. * Function takes arguments evt and ui. * Use ui.zoomWindow.left to get the current zoom window left position as a fraction of the absolute width of the target * Use ui.zoomWindow.width to get the current zoom window width as a fraction of the absolute width of the target @@ -84464,38 +84464,38 @@ interface IgZoombar { windowResized?: WindowResizedEvent; /** - * Option for igZoombar + * Option for igZoombar */ [optionName: string]: any; } interface IgZoombarMethods { /** - * Destroys the Zoombar widget + * Destroys the Zoombar widget */ destroy(): void; /** - * Returns the main zoombar element + * Returns the main zoombar element */ widget(): void; /** - * Returns the ID of the element the zoombar is initialized on + * Returns the ID of the element the zoombar is initialized on */ id(): string; /** - * Returns the DIV that is the topmost container of the zoombar widget + * Returns the DIV that is the topmost container of the zoombar widget */ container(): Element; /** - * Returns the element the clone widget is initialized on + * Returns the element the clone widget is initialized on */ clone(): Element; /** - * Gets or sets the current zoom window + * Gets or sets the current zoom window * * @param left The left parameter of the new zoom window in percentages * @param width The width parameter of the new zoom window in percentages @@ -84508,12 +84508,12 @@ interface JQuery { interface ZoombarProviderDefaultSettings { /** - * Contains the target component's instance + * Contains the target component's instance */ targetObject?: any; /** - * Expects two parameters + * Expects two parameters * a jQuery Event to pass as original for Zoombar's own zoomChanged event * an object with the following structure: * { @@ -84527,7 +84527,7 @@ interface ZoombarProviderDefaultSettings { zoomChangedCallback?: any; /** - * Option for ZoombarProviderDefaultSettings + * Option for ZoombarProviderDefaultSettings */ [optionName: string]: any; } diff --git a/types/in-range/in-range-tests.ts b/types/in-range/in-range-tests.ts index a10113bd0f..041aea264e 100644 --- a/types/in-range/in-range-tests.ts +++ b/types/in-range/in-range-tests.ts @@ -6,4 +6,4 @@ inRange(30, 10, 100); inRange(30, 100, 10); -inRange(30, 10); \ No newline at end of file +inRange(30, 10); diff --git a/types/indent-string/indent-string-tests.ts b/types/indent-string/indent-string-tests.ts index 6e5e764cb4..296a05b414 100644 --- a/types/indent-string/indent-string-tests.ts +++ b/types/indent-string/indent-string-tests.ts @@ -6,4 +6,4 @@ indentString('Unicorns\nRainbows', 4); indentString('Unicorns\nRainbows', 4, '♥'); // => '♥♥♥♥Unicorns' -// => '♥♥♥♥Rainbows' \ No newline at end of file +// => '♥♥♥♥Rainbows' diff --git a/types/inert/index.d.ts b/types/inert/index.d.ts index fdd3d91bcd..9acbd6f1a7 100644 --- a/types/inert/index.d.ts +++ b/types/inert/index.d.ts @@ -12,4 +12,4 @@ /// -export var inert: any; \ No newline at end of file +export const inert: any; diff --git a/types/intl-messageformat/intl-messageformat-tests.ts b/types/intl-messageformat/intl-messageformat-tests.ts index e758210bbf..1e4c8e1167 100644 --- a/types/intl-messageformat/intl-messageformat-tests.ts +++ b/types/intl-messageformat/intl-messageformat-tests.ts @@ -1,13 +1,11 @@ import IntlMessageFormat = require("intl-messageformat"); +let msg = new IntlMessageFormat("message", "en-us"); -var msg = new IntlMessageFormat("message", "en-us"); - - -var output = msg.format({name: "Eric"}); +let output = msg.format({name: "Eric"}); console.log(output); // => "My name is Eric." -var MESSAGES = { +const MESSAGES = { 'en-US': { NUM_PHOTOS: 'You have {numPhotos, plural, ' + '=0 {no photos.}' + @@ -23,16 +21,15 @@ var MESSAGES = { } }; -var enNumPhotos = new IntlMessageFormat(MESSAGES['en-US'].NUM_PHOTOS, 'en-US'); +const enNumPhotos = new IntlMessageFormat(MESSAGES['en-US'].NUM_PHOTOS, 'en-US'); output = enNumPhotos.format({numPhotos: 1000}); console.log(output); // => "You have 1,000 photos." -var esNumPhotos = new IntlMessageFormat(MESSAGES['es-MX'].NUM_PHOTOS, 'es-MX'); +const esNumPhotos = new IntlMessageFormat(MESSAGES['es-MX'].NUM_PHOTOS, 'es-MX'); output = esNumPhotos.format({numPhotos: 1000}); console.log(output); // => "Usted tiene 1,000 fotos." - -var msg = new IntlMessageFormat('The price is: {price, number, USD}', 'en-US', { +msg = new IntlMessageFormat('The price is: {price, number, USD}', 'en-US', { number: { USD: { style : 'currency', @@ -41,5 +38,5 @@ var msg = new IntlMessageFormat('The price is: {price, number, USD}', 'en-US', { } }); -var output = msg.format({price: 100}); -console.log(output); // => "The price is: $100.00" \ No newline at end of file +output = msg.format({price: 100}); +console.log(output); // => "The price is: $100.00" diff --git a/types/is-absolute-url/is-absolute-url-tests.ts b/types/is-absolute-url/is-absolute-url-tests.ts index 47c5f007ed..4f8a225dad 100644 --- a/types/is-absolute-url/is-absolute-url-tests.ts +++ b/types/is-absolute-url/is-absolute-url-tests.ts @@ -7,4 +7,4 @@ isAbsoluteUrl('//sindresorhus.com'); // => false isAbsoluteUrl('foo/bar'); -// => false \ No newline at end of file +// => false diff --git a/types/is-archive/is-archive-tests.ts b/types/is-archive/is-archive-tests.ts index 332deae7ec..c5c947c0d8 100644 --- a/types/is-archive/is-archive-tests.ts +++ b/types/is-archive/is-archive-tests.ts @@ -4,4 +4,4 @@ isArchive('src/unicorn.zip'); // => true isArchive('src/unicorn.txt'); -// => false \ No newline at end of file +// => false diff --git a/types/is-array/is-array-tests.ts b/types/is-array/is-array-tests.ts index 327c2ea3d0..7881b87574 100644 --- a/types/is-array/is-array-tests.ts +++ b/types/is-array/is-array-tests.ts @@ -7,7 +7,7 @@ isArray(true); isArray([]); isArray({}); -var x = {}; +const x = {}; if (isArray(x)) { x.push(0); } diff --git a/types/is-binary-path/is-binary-path-tests.ts b/types/is-binary-path/is-binary-path-tests.ts index 43505a5b32..59d9fe3c04 100644 --- a/types/is-binary-path/is-binary-path-tests.ts +++ b/types/is-binary-path/is-binary-path-tests.ts @@ -2,4 +2,4 @@ import isBinaryPath = require("is-binary-path"); const a: boolean = isBinaryPath("src/unicorn.png"); -const b: boolean = isBinaryPath("src/unicorn.txt"); \ No newline at end of file +const b: boolean = isBinaryPath("src/unicorn.txt"); diff --git a/types/is-compressed/is-compressed-tests.ts b/types/is-compressed/is-compressed-tests.ts index 7720b334a4..3a97ccc350 100644 --- a/types/is-compressed/is-compressed-tests.ts +++ b/types/is-compressed/is-compressed-tests.ts @@ -4,4 +4,4 @@ isCompressed('src/unicorn.zip'); // => true isCompressed('src/unicorn.txt'); -// => false \ No newline at end of file +// => false diff --git a/types/is-path-cwd/index.d.ts b/types/is-path-cwd/index.d.ts index c00b20dae8..468f06dbc6 100644 --- a/types/is-path-cwd/index.d.ts +++ b/types/is-path-cwd/index.d.ts @@ -4,4 +4,4 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare function isPathCwd(path: string): boolean; -export = isPathCwd; \ No newline at end of file +export = isPathCwd; diff --git a/types/is-path-cwd/is-path-cwd-tests.ts b/types/is-path-cwd/is-path-cwd-tests.ts index 80398a23cd..51405530ef 100644 --- a/types/is-path-cwd/is-path-cwd-tests.ts +++ b/types/is-path-cwd/is-path-cwd-tests.ts @@ -1,3 +1,3 @@ import isPathCwd = require("is-path-cwd"); -isPathCwd("unicorn"); \ No newline at end of file +isPathCwd("unicorn"); diff --git a/types/is-relative-url/is-relative-url-tests.ts b/types/is-relative-url/is-relative-url-tests.ts index 8835694624..2e93e6f4ed 100644 --- a/types/is-relative-url/is-relative-url-tests.ts +++ b/types/is-relative-url/is-relative-url-tests.ts @@ -7,4 +7,4 @@ isRelativeUrl('http://sindresorhus.com/foo/bar'); // => false isRelativeUrl('//sindresorhus.com'); -// => true \ No newline at end of file +// => true diff --git a/types/is-root-path/is-root-path-tests.ts b/types/is-root-path/is-root-path-tests.ts index 3e050cd162..ec5256ebaf 100644 --- a/types/is-root-path/is-root-path-tests.ts +++ b/types/is-root-path/is-root-path-tests.ts @@ -4,4 +4,4 @@ isRootPath('/'); // => true isRootPath('/Users'); -// => false \ No newline at end of file +// => false diff --git a/types/is-root/is-root-tests.ts b/types/is-root/is-root-tests.ts index b53d07a0ac..99be761d74 100644 --- a/types/is-root/is-root-tests.ts +++ b/types/is-root/is-root-tests.ts @@ -2,4 +2,4 @@ import isRoot = require('is-root'); isRoot(); -// => true \ No newline at end of file +// => true diff --git a/types/is-text-path/is-text-path-tests.ts b/types/is-text-path/is-text-path-tests.ts index f7c417fe51..378614cfbe 100644 --- a/types/is-text-path/is-text-path-tests.ts +++ b/types/is-text-path/is-text-path-tests.ts @@ -4,4 +4,4 @@ isTextPath('src/unicorn.txt'); // => true isTextPath('src/unicorn.png'); -// => false \ No newline at end of file +// => false diff --git a/types/is-windows/is-windows-tests.ts b/types/is-windows/is-windows-tests.ts index 79ada21511..e62af8cad3 100644 --- a/types/is-windows/is-windows-tests.ts +++ b/types/is-windows/is-windows-tests.ts @@ -1,3 +1,3 @@ import * as isWindows from 'is-windows'; -var bool: boolean = isWindows(); +const bool: boolean = isWindows(); diff --git a/types/isbn-utils/index.d.ts b/types/isbn-utils/index.d.ts index fe2ac4dae9..f0e1fe5515 100644 --- a/types/isbn-utils/index.d.ts +++ b/types/isbn-utils/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Jørgen Elgaard Larsen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - type IGroups = any; export class ISBNcodes { diff --git a/types/isbn-utils/isbn-utils-tests.ts b/types/isbn-utils/isbn-utils-tests.ts index 91f72a0359..24a91ffa6a 100644 --- a/types/isbn-utils/isbn-utils-tests.ts +++ b/types/isbn-utils/isbn-utils-tests.ts @@ -1,6 +1,5 @@ import * as isbn from 'isbn-utils'; - const isbn10a: isbn.ISBN|null = isbn.parse('4873113369'); let b: boolean; let s: string; diff --git a/types/isotope-layout/index.d.ts b/types/isotope-layout/index.d.ts index 08694f0418..007740df8e 100644 --- a/types/isotope-layout/index.d.ts +++ b/types/isotope-layout/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace IsotopeLibrary { - type LayoutModes = 'masonry' | 'fitRows' | 'cellsByRow' | 'vertical' | 'packery' | 'masonryHorizontal' | 'fitColumns' | 'cellsByColumn' | 'horiz'; type Elements = HTMLElement[] | HTMLElement | JQuery | NodeList; @@ -125,9 +124,9 @@ declare namespace IsotopeLibrary { interface Isotope { /** - * Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. - * @param elements Element, jQuery Object, NodeList, or Array of Elements - */ + * Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. + * @param elements Element, jQuery Object, NodeList, or Array of Elements + */ addItems(elements: Elements): void; /** * Adds and lays out newly appended item elements to the end of the layout. @@ -266,7 +265,7 @@ declare namespace IsotopeLibrary { } } -interface Isotope extends IsotopeLibrary.Isotope{ } +interface Isotope extends IsotopeLibrary.Isotope { } declare var Isotope: { prototype: IsotopeLibrary.Isotope; @@ -274,11 +273,11 @@ declare var Isotope: { /** * Get the Isotope instance via its element. Isotope.data() is useful for getting the Isotope instance in JavaScript, after it has been initalized in HTML. */ - data: (element: HTMLElement | string) => IsotopeLibrary.Isotope; -} + data(element: HTMLElement | string): IsotopeLibrary.Isotope; +}; interface JQuery { - // tslint:disable:unified-signatures + // tslint:disable:unified-signatures /** * Get the Isotope instance from a jQuery object. Isotope instances are useful to access Isotope properties. */ @@ -323,7 +322,7 @@ interface JQuery { * Reveals hidden items. * @param elements Element, jQuery Object, NodeList, or Array of Elements */ - isotope(methodName: 'revealItemElements', elements: IsotopeLibrary.Elements): JQuery; + isotope(methodName: 'revealItemElements', elements: IsotopeLibrary.Elements): JQuery; /** * Stamps elements in the layout. Isotope will lay out item elements around stamped elements. * Stamping is only supported by some layout modes: masonry, packery and masonryhorizontal. @@ -371,4 +370,4 @@ interface JQuery { */ isotope(options: IsotopeLibrary.IsotopeOptions): JQuery; // tslint:enable -} \ No newline at end of file +} diff --git a/types/isotope-layout/isotope-layout-tests.ts b/types/isotope-layout/isotope-layout-tests.ts index c82defa279..8f20d52fcc 100644 --- a/types/isotope-layout/isotope-layout-tests.ts +++ b/types/isotope-layout/isotope-layout-tests.ts @@ -11,7 +11,7 @@ let $grid = $('.grid').isotope({ rowHeight: 250 }, containerStyle: { - 'display': 'block' + display: 'block' }, filter: 'filter', fitRows: { @@ -21,16 +21,16 @@ let $grid = $('.grid').isotope({ itemSelector: '.grid-item', layoutMode: 'cellsByRow', getSortData: { - 'value': '.value', - 'key': (itemElm: JQuery): string => { + value: '.value', + key: (itemElm: JQuery): string => { return '.key'; }, - 'description': (itemElm: JQuery): number => { + description: (itemElm: JQuery): number => { return 1; } }, hiddenStyle: { - 'display': 'none' + display: 'none' }, horiz: { verticalAligment: 10 @@ -63,7 +63,7 @@ let $grid = $('.grid').isotope({ horizontalAlignment: 10 }, visibleStyle: { - 'display': 'inline-block' + display: 'inline-block' } }); @@ -73,7 +73,7 @@ $grid = $('.grid').isotope({ return true; }, sortAscending: { - 'key': true + key: true }, stagger: 'a', transitionDuration: 0.4 @@ -81,7 +81,7 @@ $grid = $('.grid').isotope({ // test methods using jquery $grid.isotope('addItems', $('.items')); -$grid.isotope('appended', $('.items')[0]) +$grid.isotope('appended', $('.items')[0]); $grid.isotope('hideItemElements', [ new HTMLElement() ]); $grid.isotope('insert', new HTMLElement()); $grid.isotope('prepended', new NodeList()); diff --git a/types/isotope-layout/tslint.json b/types/isotope-layout/tslint.json index 606d515fec..105f5736e6 100644 --- a/types/isotope-layout/tslint.json +++ b/types/isotope-layout/tslint.json @@ -1,3 +1,6 @@ -{ - "extends": "../tslint.json" +{ + "extends": "../tslint.json", + "rules": { + "no-empty-interface": false + } } diff --git a/types/ityped/index.d.ts b/types/ityped/index.d.ts index 135ea870ca..ea5c2427a6 100644 --- a/types/ityped/index.d.ts +++ b/types/ityped/index.d.ts @@ -12,4 +12,4 @@ export interface Configuration { export function init(element: string, config: Configuration): void; -export as namespace ityped; \ No newline at end of file +export as namespace ityped; diff --git a/types/ityped/ityped-tests.ts b/types/ityped/ityped-tests.ts index b03d976ec1..cb18814532 100644 --- a/types/ityped/ityped-tests.ts +++ b/types/ityped/ityped-tests.ts @@ -15,4 +15,4 @@ init("#anotherSelector", { loop: false }); -init("#anotherOne", {}); \ No newline at end of file +init("#anotherOne", {}); diff --git a/types/jasmine-ajax/jasmine-ajax-tests.ts b/types/jasmine-ajax/jasmine-ajax-tests.ts index 96b7020577..b2c963c6c1 100644 --- a/types/jasmine-ajax/jasmine-ajax-tests.ts +++ b/types/jasmine-ajax/jasmine-ajax-tests.ts @@ -751,11 +751,13 @@ describe('FakeRequest', () => { }); describe("Jasmine Mock Ajax (for toplevel)", () => { + // tslint:disable one-variable-per-declaration let request, anotherRequest, response; let success, error, complete; let client, onreadystatechange; const sharedContext: any = {}; let fakeGlobal, mockAjax; + // tslint:enable beforeEach(() => { const fakeXMLHttpRequest = jasmine.createSpy('realFakeXMLHttpRequest'); @@ -1266,8 +1268,8 @@ describe('ParamParser', () => { }); it('has a default parser', () => { - const parser = this.parser.findParser({ contentType: () => { } }), - parsed = parser.parse('3+stooges=shemp&3+stooges=larry%20%26%20moe%20%26%20curly&some%3Dthing=else+entirely'); + const parser = this.parser.findParser({ contentType: () => { } }); + const parsed = parser.parse('3+stooges=shemp&3+stooges=larry%20%26%20moe%20%26%20curly&some%3Dthing=else+entirely'); expect(parsed).toEqual({ '3 stooges': ['shemp', 'larry & moe & curly'], @@ -1284,9 +1286,9 @@ describe('ParamParser', () => { containing: 'stuff' } } - }, - parser = this.parser.findParser({ contentType: () => 'application/json' }), - parsed = parser.parse(JSON.stringify(data)); + }; + const parser = this.parser.findParser({ contentType: () => 'application/json' }); + const parsed = parser.parse(JSON.stringify(data)); expect(parsed).toEqual(data); }); @@ -1300,9 +1302,9 @@ describe('ParamParser', () => { containing: 'stuff' } } - }, - parser = this.parser.findParser({ contentType: () => 'application/json; charset=utf-8' }), - parsed = parser.parse(JSON.stringify(data)); + }; + const parser = this.parser.findParser({ contentType: () => 'application/json; charset=utf-8' }); + const parsed = parser.parse(JSON.stringify(data)); expect(parsed).toEqual(data); }); @@ -1315,8 +1317,8 @@ describe('ParamParser', () => { this.parser.add(custom); - const parser = this.parser.findParser({ contentType: () => { } }), - parsed = parser.parse('custom_format'); + const parser = this.parser.findParser({ contentType: () => { } }); + const parsed = parser.parse('custom_format'); expect(parsed).toEqual('parsedFormat'); expect(custom.test).toHaveBeenCalled(); @@ -1331,8 +1333,8 @@ describe('ParamParser', () => { this.parser.add(custom); - const parser = this.parser.findParser({ contentType: () => { } }), - parsed = parser.parse('custom_format'); + const parser = this.parser.findParser({ contentType: () => { } }); + const parsed = parser.parse('custom_format'); expect(parsed).toEqual({ custom_format: ['undefined'] }); expect(custom.test).toHaveBeenCalled(); @@ -1347,8 +1349,8 @@ describe('ParamParser', () => { this.parser.add(custom); - let parser = this.parser.findParser({ contentType: () => { } }), - parsed = parser.parse('custom_format'); + let parser = this.parser.findParser({ contentType: () => { } }); + let parsed = parser.parse('custom_format'); expect(parsed).toEqual('parsedFormat'); @@ -1541,8 +1543,8 @@ describe('EventBus', () => { }); it('only triggers callbacks for the specified event', () => { - const fooCallback = jasmine.createSpy('foo'), - barCallback = jasmine.createSpy('bar'); + const fooCallback = jasmine.createSpy('foo'); + const barCallback = jasmine.createSpy('bar'); this.bus.addEventListener('foo', fooCallback); this.bus.addEventListener('bar', barCallback); @@ -1599,7 +1601,7 @@ describe('EventBus', () => { }); describe("Webmock style mocking", () => { - let successSpy, response, fakeGlobal, mockAjax; + let successSpy, response, fakeGlobal, mockAjax; // tslint:disable-line one-variable-per-declaration const sendRequest = function(fakeGlobal, url?, method?) { url = url || "http://example.com/someApi"; @@ -1685,10 +1687,10 @@ describe("withMock", () => { }; it("installs the mock for passed in function, and uninstalls when complete", () => { - const xmlHttpRequest = jasmine.createSpyObj('XMLHttpRequest', ['open', 'send']), - xmlHttpRequestCtor = spyOn(window as any, 'XMLHttpRequest').and.returnValue(xmlHttpRequest), - fakeGlobal = { XMLHttpRequest: xmlHttpRequestCtor }, - mockAjax = new MockAjax(fakeGlobal); + const xmlHttpRequest = jasmine.createSpyObj('XMLHttpRequest', ['open', 'send']); + const xmlHttpRequestCtor = spyOn(window as any, 'XMLHttpRequest').and.returnValue(xmlHttpRequest); + const fakeGlobal = { XMLHttpRequest: xmlHttpRequestCtor }; + const mockAjax = new MockAjax(fakeGlobal); mockAjax.withMock(() => { sendRequest(fakeGlobal); @@ -1700,10 +1702,10 @@ describe("withMock", () => { }); it("properly uninstalls when the passed in function throws", () => { - const xmlHttpRequest = jasmine.createSpyObj('XMLHttpRequest', ['open', 'send']), - xmlHttpRequestCtor = spyOn(window as any, 'XMLHttpRequest').and.returnValue(xmlHttpRequest), - fakeGlobal = { XMLHttpRequest: xmlHttpRequestCtor }, - mockAjax = new MockAjax(fakeGlobal); + const xmlHttpRequest = jasmine.createSpyObj('XMLHttpRequest', ['open', 'send']); + const xmlHttpRequestCtor = spyOn(window as any, 'XMLHttpRequest').and.returnValue(xmlHttpRequest); + const fakeGlobal = { XMLHttpRequest: xmlHttpRequestCtor }; + const mockAjax = new MockAjax(fakeGlobal); expect(() => { mockAjax.withMock(() => { @@ -1718,9 +1720,9 @@ describe("withMock", () => { describe("mockAjax", () => { it("throws an error if installed multiple times", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); function doubleInstall() { mockAjax.install(); @@ -1731,9 +1733,9 @@ describe("mockAjax", () => { }); it("does not throw an error if uninstalled between installs", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); function sequentialInstalls() { mockAjax.install(); @@ -1745,9 +1747,9 @@ describe("mockAjax", () => { }); it("does not replace XMLHttpRequest until it is installed", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); fakeGlobal.XMLHttpRequest('foo'); expect(fakeXmlHttpRequest).toHaveBeenCalledWith('foo'); @@ -1759,9 +1761,9 @@ describe("mockAjax", () => { }); it("replaces the global XMLHttpRequest on uninstall", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); mockAjax.install(); mockAjax.uninstall(); @@ -1771,9 +1773,9 @@ describe("mockAjax", () => { }); it("clears requests and stubs upon uninstall", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); mockAjax.install(); @@ -1790,9 +1792,9 @@ describe("mockAjax", () => { }); it("allows the httpRequest to be retrieved", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); mockAjax.install(); const request = new ( fakeGlobal.XMLHttpRequest)(); @@ -1802,9 +1804,9 @@ describe("mockAjax", () => { }); it("allows the httpRequests to be cleared", () => { - const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'), - fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }, - mockAjax = new MockAjax(fakeGlobal); + const fakeXmlHttpRequest = jasmine.createSpy('fakeXmlHttpRequest'); + const fakeGlobal = { XMLHttpRequest: fakeXmlHttpRequest }; + const mockAjax = new MockAjax(fakeGlobal); mockAjax.install(); const request = new ( fakeGlobal.XMLHttpRequest)(); diff --git a/types/jasmine-data_driven_tests/jasmine-data_driven_tests-tests.ts b/types/jasmine-data_driven_tests/jasmine-data_driven_tests-tests.ts index 727c253ad3..6689159b58 100644 --- a/types/jasmine-data_driven_tests/jasmine-data_driven_tests-tests.ts +++ b/types/jasmine-data_driven_tests/jasmine-data_driven_tests-tests.ts @@ -38,7 +38,7 @@ xall("A data driven test can be pending", ); describe("A suite", () => { - var a: number; + let a: number; beforeEach(() => { a = 5; @@ -50,4 +50,4 @@ describe("A suite", () => { expect(a - b > 0).toBe(true); } ); -}); \ No newline at end of file +}); diff --git a/types/jasmine-fixture/index.d.ts b/types/jasmine-fixture/index.d.ts index 9a8c7b98b2..f018dde1cf 100644 --- a/types/jasmine-fixture/index.d.ts +++ b/types/jasmine-fixture/index.d.ts @@ -14,7 +14,7 @@ declare function affix(selector: string): JQuery; interface JQuery { /** Affixes the given jquery selectors into the element and will be removed after each spec - * @param {string} selector The JQuery selector to be added to the dom - */ + * @param {string} selector The JQuery selector to be added to the dom + */ affix(selector: string): JQuery; } diff --git a/types/jasmine-fixture/jasmine-fixture-tests.ts b/types/jasmine-fixture/jasmine-fixture-tests.ts index 74eb750590..9710fe338b 100644 --- a/types/jasmine-fixture/jasmine-fixture-tests.ts +++ b/types/jasmine-fixture/jasmine-fixture-tests.ts @@ -12,8 +12,8 @@ describe("Jasmine fixture extension", () => { it("Inserts subelements when given", () => { affix('#test2 .something-special'); expect('.something-special').toExist(); - var parent = $('#test2 .something-special').parent(); - var id = parent.attr('id'); + const parent = $('#test2 .something-special').parent(); + const id = parent.attr('id'); expect(id).toBe('test2'); }); @@ -43,4 +43,4 @@ describe("Jasmine fixture extension", () => { expect('#test3').not.toExist(); }); }); -}); \ No newline at end of file +}); diff --git a/types/jimp/index.d.ts b/types/jimp/index.d.ts index b8988e2ad4..4c39f58796 100644 --- a/types/jimp/index.d.ts +++ b/types/jimp/index.d.ts @@ -50,7 +50,6 @@ declare namespace jimp { } } | PresetFont; - class JimpImage { constructor(width: number, height: number, callback?: Callback); constructor(width: number, height: number, initialColor: number, callback?: Callback); diff --git a/types/jimp/jimp-tests.ts b/types/jimp/jimp-tests.ts index a312cd4586..10ee61073e 100644 --- a/types/jimp/jimp-tests.ts +++ b/types/jimp/jimp-tests.ts @@ -36,20 +36,20 @@ Jimp.read("http://www.example.com/path/to/lenna.jpg", (err, image) => { // do stuff with the image (if no exception) }); -var image = new Jimp(1, 2); -var w = 0; -var h = 0; -var x = 0; -var y = 0; -var f = 0; -var src = ''; -var horz = Jimp.HORIZONTAL_ALIGN_CENTER; -var vert = Jimp.VERTICAL_ALIGN_BOTTOM; -var deg = 90; -var val = 0.5; -var hex = 0xFFFFFFFF; -var r = 0; -var n = 1; +let image = new Jimp(1, 2); +const w = 0; +const h = 0; +const x = 0; +const y = 0; +const f = 0; +const src = ''; +const horz = Jimp.HORIZONTAL_ALIGN_CENTER; +const vert = Jimp.VERTICAL_ALIGN_BOTTOM; +const deg = 90; +const val = 0.5; +const hex = 0xFFFFFFFF; +const r = 0; +const n = 1; /* Resize */ image.contain(w, h); // scale the image to the given width and height, some parts of the image may be letter boxed image.cover(w, h); // scale the image to the given width and height, some parts of the image may be clipped @@ -112,15 +112,15 @@ image.resize(250, 250, Jimp.RESIZE_BEZIER); image.contain(250, 250, Jimp.HORIZONTAL_ALIGN_LEFT | Jimp.VERTICAL_ALIGN_TOP); -var path = ''; -var str = ''; -var width = 0; +const path = ''; +const str = ''; +const width = 0; Jimp.loadFont(path).then(font => { // load font from .fnt file image.print(font, x, y, str); // print a message on an image image.print(font, x, y, str, width); // print a message on an image with text wrapped at width }); -var cb = (err: Error, data: any) => {}; +const cb = (err: Error, data: any) => {}; Jimp.loadFont(path, cb); // using a callback pattern Jimp.loadFont(Jimp.FONT_SANS_32_BLACK).then(font => { @@ -129,17 +129,16 @@ Jimp.loadFont(Jimp.FONT_SANS_32_BLACK).then(font => { image.write(path, cb); // Node-style callback will be fired when write is successful -var file = "new_name." + image.getExtension(); +const file = "new_name." + image.getExtension(); image.write(file); - -var mime = 'image/png'; +const mime = 'image/png'; image.getBuffer(mime, cb); // Node-style callback will be fired with result image.getBase64(mime, cb); // Node-style callback will be fired with result image.quality(n); // set the quality of saved JPEG, 0 - 100 -var bool = true; -var number = 0; +const bool = true; +const number = 0; image.rgba(bool); // set whether PNGs are saved as RGBA (true, default) or RGB (false) image.filterType(number); // set the filter type for the saved PNG image.deflateLevel(number); // set the deflate level for the saved PNG @@ -160,10 +159,10 @@ image.scan(0, 0, image.bitmap.width, image.bitmap.height, function(x, y, idx) { // idx is the position start position of this rgba tuple in the bitmap Buffer // this is the image - var red = this.bitmap.data[ idx + 0 ]; - var green = this.bitmap.data[ idx + 1 ]; - var blue = this.bitmap.data[ idx + 2 ]; - var alpha = this.bitmap.data[ idx + 3 ]; + const red = this.bitmap.data[ idx + 0 ]; + const green = this.bitmap.data[ idx + 1 ]; + const blue = this.bitmap.data[ idx + 2 ]; + const alpha = this.bitmap.data[ idx + 3 ]; // rgba values run from 0 - 255 // e.g. this.bitmap.data[idx] = 0; // removes red from this pixel @@ -171,35 +170,34 @@ image.scan(0, 0, image.bitmap.width, image.bitmap.height, function(x, y, idx) { image.getPixelColor(x, y); // returns the colour of that pixel e.g. 0xFFFFFFFF image.setPixelColor(hex, x, y); // sets the colour of that pixel -var g = 0; -var b = 0; -var a = 0; +const g = 0; +const b = 0; +const a = 0; Jimp.rgbaToInt(r, g, b, a); // e.g. converts 255, 255, 255, 255 to 0xFFFFFFFF Jimp.intToRGBA(hex); // e.g. converts 0xFFFFFFFF to {r: 255, g: 255, b: 255, a:255} -var image = new Jimp(256, 256, (err, image) => { +image = new Jimp(256, 256, (err, image) => { // this image is 256 x 256, every pixel is set to 0x00000000 }); -var image = new Jimp(256, 256, 0xFF0000FF, (err, image) => { +image = new Jimp(256, 256, 0xFF0000FF, (err, image) => { // this image is 256 x 256, every pixel is set to 0xFF0000FF }); image.hash(); // aHgG4GgoFjA image.hash(2); // 1010101011010000101010000100101010010000011001001001010011100100 -var image1 = new Jimp(0, 1); -var image2 = new Jimp(0, 1); +const image1 = new Jimp(0, 1); +const image2 = new Jimp(0, 1); Jimp.distance(image1, image2); // returns a number 0-1, where 0 means the two images are perceived to be identical -var threshold = 0; -var diff = Jimp.diff(image1, image2, threshold); // threshold ranges 0-1 (default: 0.1) +const threshold = 0; +let diff = Jimp.diff(image1, image2, threshold); // threshold ranges 0-1 (default: 0.1) diff.image; // a Jimp image showing differences diff.percent; // the proportion of different pixels (0-1), where 0 means the images are pixel identical - -var distance = Jimp.distance(image, image2); // perceived distance -var diff = Jimp.diff(image, image2); // pixel difference +const distance = Jimp.distance(image, image2); // perceived distance +diff = Jimp.diff(image, image2); // pixel difference if (distance < 0.15 || diff.percent < 0.15) { // images match @@ -217,4 +215,4 @@ Jimp.read("lenna.png", (err, image) => { image.write("lena-half-bw.png"); }); }); -}); \ No newline at end of file +}); diff --git a/types/jquery-toastmessage-plugin/index.d.ts b/types/jquery-toastmessage-plugin/index.d.ts index 6ca6816e21..9e5eb8e8b9 100644 --- a/types/jquery-toastmessage-plugin/index.d.ts +++ b/types/jquery-toastmessage-plugin/index.d.ts @@ -30,7 +30,8 @@ declare namespace JQueryToastmessage { /** in effect duration in miliseconds @default 600 */ inEffectDuration?: number; /** - * time in miliseconds before the item has to disappear @default 3000 */ + * time in miliseconds before the item has to disappear @default 3000 + */ stayTime?: number; /** content of the item @default '' */ text?: string; @@ -52,6 +53,6 @@ declare namespace JQueryToastmessage { */ closeText?: string; /** callback function when the toastmessage is closed @default null */ - close?: () => void; + close?(): void; } } diff --git a/types/jquery.tools/index.d.ts b/types/jquery.tools/index.d.ts index fa1bc80cb4..d84db10e7b 100644 --- a/types/jquery.tools/index.d.ts +++ b/types/jquery.tools/index.d.ts @@ -122,13 +122,13 @@ declare namespace JQueryTools { * before the overlay is displayed. The overlay has already been positioned at the * location from where it will start animating. */ - onBeforeLoad?: (this: Overlay, event: JQueryEventObject) => void; + onBeforeLoad?(this: Overlay, event: JQueryEventObject): void; /** when the overlay has completely been displayed */ - onLoad?: (this: Overlay, event: JQueryEventObject) => void; + onLoad?(this: Overlay, event: JQueryEventObject): void; /** before the overlay is closed */ - onBeforeClose?: (this: Overlay, event: JQueryEventObject) => void; + onBeforeClose?(this: Overlay, event: JQueryEventObject): void; /** when the overlay is closed */ - onClose?: (this: Overlay, event: JQueryEventObject) => void; + onClose?(this: Overlay, event: JQueryEventObject): void; } interface MaskOptions { diff --git a/types/jquery.tools/jquery.tools-tests.ts b/types/jquery.tools/jquery.tools-tests.ts index 5092b49bff..a2a8f93ab9 100644 --- a/types/jquery.tools/jquery.tools-tests.ts +++ b/types/jquery.tools/jquery.tools-tests.ts @@ -1,33 +1,31 @@ /* from documentation at http://jquerytools.github.io/documentation/overlay/index.html */ - $("img[rel]").overlay(); +$("img[rel]").overlay(); - const triggers = $(".modalInput").overlay({ -  - // some mask tweaks suitable for modal dialogs - mask: { +const triggers = $(".modalInput").overlay({ + // some mask tweaks suitable for modal dialogs + mask: { color: '#ebecff', loadSpeed: 200, opacity: 0.9 - }, -  - closeOnClick: false - }); + }, - const buttons = $("#yesno button").click(function(this: JQuery, e: JQueryEventObject) { -  - // get user input - const yes = buttons.index(this) === 0; -  - // do something with the answer - triggers.eq(0).html("You clicked " + (yes ? "yes" : "no")); - }); + closeOnClick: false +}); + +const buttons = $("#yesno button").click(function(this: JQuery, e: JQueryEventObject) { + // get user input + const yes = buttons.index(this) === 0; + + // do something with the answer + triggers.eq(0).html("You clicked " + (yes ? "yes" : "no")); +}); // select one or more elements to be overlay triggers $(".my_overlay_trigger").overlay({ // one configuration property mask: { - color: '#ccc' + color: '#ccc' }, // another property top: 50 @@ -35,44 +33,44 @@ $(".my_overlay_trigger").overlay({ }); $("#prompt form").submit(function(this: JQuery, e: JQueryEventObject) { -  - // close the overlay - triggers.eq(1).overlay().close(); - // or more straightforward: - triggers.data('overlay').close(); -  - // get user input - const input = $("input", this).val(); -  - // do something with the answer - triggers.eq(1).html(input); -  - // do not submit the form - return e.preventDefault(); - }); + // close the overlay + triggers.eq(1).overlay().close(); + // or more straightforward: + triggers.data('overlay').close(); + + // get user input + const input = $("input", this).val(); + + // do something with the answer + triggers.eq(1).html(input); + + // do not submit the form + return e.preventDefault(); +}); $.tools.overlay.addEffect('', () => {}, () => {}); /* custom effects */ -$.tools.overlay.addEffect("myEffect", function(position, done) { - /* - - 'this' variable is a reference to the overlay API - - here we use jQuery's fadeIn() method to perform the effect - */ - this.getOverlay().css(position).fadeIn(this.getConf().speed, done); - }, -  - // close function - function(done) { - // fade out the overlay - this.getOverlay().fadeOut(this.getConf().closeSpeed, done); - } +$.tools.overlay.addEffect("myEffect", + function(position, done) { + /* + - 'this' variable is a reference to the overlay API + - here we use jQuery's fadeIn() method to perform the effect + */ + this.getOverlay().css(position).fadeIn(this.getConf().speed, done); + }, + + // close function + function(done) { + // fade out the overlay + this.getOverlay().fadeOut(this.getConf().closeSpeed, done); + } ); $("#apple img[rel]").overlay({effect: 'apple'}); - // select the overlay element - and "make it an overlay" - $("#facebox").overlay({ +// select the overlay element - and "make it an overlay" +$("#facebox").overlay({ // custom top position top: 260, // some mask tweaks suitable for facebox-looking dialogs @@ -91,22 +89,19 @@ $("#apple img[rel]").overlay({effect: 'apple'}); }); $(function() { -  // if the function argument is given to overlay, // it is assumed to be the onBeforeLoad event listener $("a[rel]").overlay({ -  mask: 'darkred', effect: 'apple', -  + onBeforeLoad() { // grab wrapper element inside content const wrap = this.getOverlay().find(".contentWrap"); -  + // load the page specified in the trigger wrap.load(this.getTrigger().attr("href")); } -  }); }); @@ -118,60 +113,60 @@ $(() => { [400, 530], [0, 20] ]; -  + // setup triggers $("button[rel]").each(function(this: JQuery, i: number) { -  $(this).overlay({ -  // common configuration for each overlay oneInstance: false, closeOnClick: false, -  + // setup custom finish position top: positions[i][0], left: positions[i][1], -  // use apple effect effect: 'apple' -  }); }); }); // loading animation -$.tools.overlay.addEffect("drop", function(css, done) { -  - // use Overlay API to gain access to crucial elements - const conf = this.getConf(), - overlay = this.getOverlay(); -  - // determine initial position for the overlay - if (conf.fixed) { - css['position'] = 'fixed'; - } else { - css['top'] += $(window).scrollTop(); - css['left'] += $(window).scrollLeft(); - css['position'] = 'absolute'; +$.tools.overlay.addEffect("drop", + function(css, done) { + // use Overlay API to gain access to crucial elements + const conf = this.getConf(); + const overlay = this.getOverlay(); + + // determine initial position for the overlay + if (conf.fixed) { + css['position'] = 'fixed'; + } else { + css['top'] += $(window).scrollTop(); + css['left'] += $(window).scrollLeft(); + css['position'] = 'absolute'; + } + + // position the overlay and show it + overlay.css(css).show(); + + // begin animating with our custom easing + overlay.animate( + { top: '+=55', opacity: 1, width: '+=20'}, 400, 'drop', done + ); + + /* closing animation */ + }, + function(done) { + this.getOverlay().animate( + { top: '-=55', opacity: 0, width: '-=20' }, + 300, + 'drop', + function(this: JQuery) { + $(this).hide(); + done.call(null); + }); } -  - // position the overlay and show it - overlay.css(css).show(); -  - // begin animating with our custom easing - overlay.animate( - { top: '+=55', opacity: 1, width: '+=20'}, 400, 'drop', done - ); -  - /* closing animation */ -}, function(done) { - this.getOverlay().animate( - { top: '-=55', opacity: 0, width: '-=20' }, 300, 'drop', - function(this: JQuery) { - $(this).hide(); - done.call(null); - }); -}); +); $("img[rel]").overlay({ effect: 'drop', diff --git a/types/js-md5/index.d.ts b/types/js-md5/index.d.ts index 690279bbe4..43057e147b 100644 --- a/types/js-md5/index.d.ts +++ b/types/js-md5/index.d.ts @@ -7,24 +7,24 @@ declare namespace md5 { type message = string | any[] | Uint8Array | ArrayBuffer; interface Md5 { - array: () => number[]; - arrayBuffer: () => ArrayBuffer; - buffer: () => ArrayBuffer; - digest: () => number[]; - hex: () => string; - toString: () => string; - update: (message: message) => Md5; + array(): number[]; + arrayBuffer(): ArrayBuffer; + buffer(): ArrayBuffer; + digest(): number[]; + hex(): string; + toString(): string; + update(message: message): Md5; } interface md5 { (message: message): string; - hex: (message: message) => string; - array: (message: message) => number[]; - digest: (message: message) => number[]; - arrayBuffer: (message: message) => ArrayBuffer; - buffer: (message: message) => ArrayBuffer; - create: () => Md5; - update: (message: message) => Md5; + hex(message: message): string; + array(message: message): number[]; + digest(message: message): number[]; + arrayBuffer(message: message): ArrayBuffer; + buffer(message: message): ArrayBuffer; + create(): Md5; + update(message: message): Md5; } } diff --git a/types/js-quantities/js-quantities-tests.ts b/types/js-quantities/js-quantities-tests.ts index e7734e7520..3608c3aa06 100644 --- a/types/js-quantities/js-quantities-tests.ts +++ b/types/js-quantities/js-quantities-tests.ts @@ -11,7 +11,7 @@ interface Expect { toBeCloseTo(this: Expect, x: number, sigFigs: number): void; toThrow(this: Expect<() => void>, msg?: string): void; toContain(this: Expect, x: U): void; -}; +} declare function expect(x: T): Expect; declare function beforeEach(f: () => void): void; declare function afterEach(f: () => void): void; @@ -621,8 +621,8 @@ describe("js-quantities", () => { }); it("should be cached", () => { - const qty = Qty("100 m"), - converted = qty.to("ft"); + const qty = Qty("100 m"); + const converted = qty.to("ft"); expect(qty.to("ft") === converted).toBe(true); }); @@ -1389,9 +1389,9 @@ describe("js-quantities", () => { describe("array of values", () => { it("should be converted", () => { - const converter = Qty.swiftConverter("MPa", "bar"), - values = [250, 10, 15], - expected = [2500, 100, 150]; + const converter = Qty.swiftConverter("MPa", "bar"); + const values = [250, 10, 15]; + const expected = [2500, 100, 150]; expect(converter(values)).toEqual(expected); }); diff --git a/types/jsnlog/index.d.ts b/types/jsnlog/index.d.ts index 4d1c707b4f..62a0d355ae 100644 --- a/types/jsnlog/index.d.ts +++ b/types/jsnlog/index.d.ts @@ -9,16 +9,16 @@ // ------------------------------- /** -* Copyright 2016 Mattijs Perdeck. -* -* This project is licensed under the MIT license. -* -* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ + * Copyright 2016 Mattijs Perdeck. + * + * This project is licensed under the MIT license. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ // Declarations of all interfaces and ambient objects, except for JL itself. // Provides strong typing in both jsnlog.ts itself and in TypeScript programs that use @@ -31,8 +31,8 @@ declare namespace JL { defaultAjaxUrl?: string; clientIP?: string; requestId?: string; - defaultBeforeSend?: (xhr: XMLHttpRequest) => void; - serialize?: (obj: any) => string; + defaultBeforeSend?(xhr: XMLHttpRequest): void; + serialize?(obj: any): string; } interface JSNLogFilterOptions { @@ -57,7 +57,7 @@ declare namespace JL { interface JSNLogAjaxAppenderOptions extends JSNLogAppenderOptions { url?: string; - beforeSend?: (xhr: XMLHttpRequest) => void; + beforeSend?(xhr: XMLHttpRequest): void; } interface JSNLogLogger { diff --git a/types/json-stable-stringify/index.d.ts b/types/json-stable-stringify/index.d.ts index 3339d8f28e..95b434469c 100644 --- a/types/json-stable-stringify/index.d.ts +++ b/types/json-stable-stringify/index.d.ts @@ -3,12 +3,9 @@ // Definitions by: Matt Frantz // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - declare function stringify(obj: any, opts?: stringify.Comparator | stringify.Options): string; declare namespace stringify { - interface Element { key: string; value: any; diff --git a/types/json-stable-stringify/json-stable-stringify-tests.ts b/types/json-stable-stringify/json-stable-stringify-tests.ts index 761d01d06a..28d4a67f9a 100644 --- a/types/json-stable-stringify/json-stable-stringify-tests.ts +++ b/types/json-stable-stringify/json-stable-stringify-tests.ts @@ -1,6 +1,6 @@ import stringify = require('json-stable-stringify'); -var obj = { c: 8, b: [{z: 6, y: 5, x: 4}, 7], a: 3 }; +const obj = { c: 8, b: [{z: 6, y: 5, x: 4}, 7], a: 3 }; { console.log(stringify(obj)); @@ -8,7 +8,7 @@ var obj = { c: 8, b: [{z: 6, y: 5, x: 4}, 7], a: 3 }; { // Second arg can be a stringify.Comparator function. - var s: string = stringify(obj, (a: stringify.Element, b: stringify.Element): number => a.key < b.key ? 1 : -1); + const s: string = stringify(obj, (a: stringify.Element, b: stringify.Element): number => a.key < b.key ? 1 : -1); console.log(s); } @@ -17,20 +17,20 @@ var obj = { c: 8, b: [{z: 6, y: 5, x: 4}, 7], a: 3 }; function reverse(a: stringify.Element, b: stringify.Element): number { return a.value < b.value ? 1 : -1; } - var opts: stringify.Options = { cmp: reverse }; - var s: string = stringify(obj, opts); + const opts: stringify.Options = { cmp: reverse }; + const s: string = stringify(obj, opts); console.log(s); } { // Space can be a string. - var s: string = stringify(obj, { space: ' ' }); + const s: string = stringify(obj, { space: ' ' }); console.log(s); } { // Space can be an integer. - var s: string = stringify(obj, { space: 2 }); + const s: string = stringify(obj, { space: 2 }); console.log(s); } @@ -42,6 +42,6 @@ var obj = { c: 8, b: [{z: 6, y: 5, x: 4}, 7], a: 3 }; } return value; } - var s: string = stringify(obj, { replacer: removeStrings }); + const s: string = stringify(obj, { replacer: removeStrings }); console.log(s); } diff --git a/types/jui-core/index.d.ts b/types/jui-core/index.d.ts index 6d15361d8e..d932198d17 100644 --- a/types/jui-core/index.d.ts +++ b/types/jui-core/index.d.ts @@ -5,14 +5,15 @@ /// -declare var jui: JuiStatic; +export const jui: JuiStatic; interface UtilBase { /** * @property browser check browser agent * @property {Boolean} browser.webkit Webkit 브라우저 체크 * @property {Boolean} browser.mozilla Mozilla 브라우저 체크 - * @property {Boolean} browser.msie IE 브라우저 체크 */ + * @property {Boolean} browser.msie IE 브라우저 체크 + */ browser: { webkit: boolean, mozilla: boolean, @@ -389,11 +390,11 @@ interface JuiStatic { includeAll(): any[]; /** - * @method add - * Adds a component object created - * - * @param {Object} ui UI instance - */ + * @method add + * Adds a component object created + * + * @param {Object} ui UI instance + */ add(uiIns: any): void; /** diff --git a/types/jui-grid/jui-grid-tests.ts b/types/jui-grid/jui-grid-tests.ts index 2609e94021..3b5bfa3db8 100644 --- a/types/jui-grid/jui-grid-tests.ts +++ b/types/jui-grid/jui-grid-tests.ts @@ -40,9 +40,9 @@ jui.ready([ "grid.table" ], (table: GridTable) => { ]); const table_3_submit: Function = (index: number) => { - const name = $(table_3.root).find(".name").val(), - age = $(table_3.root).find(".age").val(), - location = $(table_3.root).find(".location").val(); + const name = $(table_3.root).find(".name").val(); + const age = $(table_3.root).find(".age").val(); + const location = $(table_3.root).find(".location").val(); //noinspection TypeScriptValidateTypes table_3.update(index, { name, age, location }); diff --git a/types/jump.js/index.d.ts b/types/jump.js/index.d.ts index 111c41d59a..5c811d8656 100644 --- a/types/jump.js/index.d.ts +++ b/types/jump.js/index.d.ts @@ -12,7 +12,7 @@ declare namespace jump { interface Options { duration?: number; offset?: number; - callback?: () => void; + callback?(): void; easing?: TransitionFunc; a11y?: boolean; } diff --git a/types/keycloak-js/index.d.ts b/types/keycloak-js/index.d.ts index 9f7e817df1..ee1ef73deb 100644 --- a/types/keycloak-js/index.d.ts +++ b/types/keycloak-js/index.d.ts @@ -308,33 +308,33 @@ declare namespace Keycloak { /** * Called when the adapter is initialized. */ - onReady?: (authenticated?: boolean) => void; + onReady?(authenticated?: boolean): void; /** * Called when a user is successfully authenticated. */ - onAuthSuccess?: () => void; + onAuthSuccess?(): void; /** * Called if there was an error during authentication. */ - onAuthError?: (errorData: KeycloakError) => void; + onAuthError?(errorData: KeycloakError): void; /** * Called when the token is refreshed. */ - onAuthRefreshSuccess?: () => void; + onAuthRefreshSuccess?(): void; /** * Called if there was an error while trying to refresh the token. */ - onAuthRefreshError?: () => void; + onAuthRefreshError?(): void; /** * Called if the user is logged out (will only be called if the session * status iframe is enabled, or in Cordova mode). */ - onAuthLogout?: () => void; + onAuthLogout?(): void; /** * Called when the access token is expired. If a refresh token is available @@ -342,7 +342,7 @@ declare namespace Keycloak { * it's not (ie. with implicit flow) you can redirect to login screen to * obtain a new access token. */ - onTokenExpired?: () => void; + onTokenExpired?(): void; /** * Called to initialize the adapter. diff --git a/types/knuddels-userapps-api/index.d.ts b/types/knuddels-userapps-api/index.d.ts index 98eb30e054..ba7a886f52 100644 --- a/types/knuddels-userapps-api/index.d.ts +++ b/types/knuddels-userapps-api/index.d.ts @@ -543,8 +543,8 @@ declare class BotUser extends User { parameters?: { displayReasonText?: string; transferDisplayType?: KnuddelTransferDisplayType; - onSuccess?: () => void; - onError?: (message: string) => void; + onSuccess?(): void; + onError?(message: string): void; }): void; } @@ -1181,26 +1181,45 @@ declare class ExternalServerAccess { * Macht einen GET-Request auf die übergebene URL und liefert den Inhalt zurück. * Diese Methode ist eine Convenience-Methode für externalServerAccess.callURL(). */ - getURL(urlString: string, parameters?: { onSuccess?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; - onFailure?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; }): void; + getURL( + urlString: string, + parameters?: { + onSuccess?(responseData: string, externalServerResponse: ExternalServerResponse): void; + onFailure?(responseData: string, externalServerResponse: ExternalServerResponse): void; + }): void; /** * Macht einen POST-Request auf die übergebene URL und liefert den Inhalt zurück. * Diese Methode ist eine Convenience-Methode für externalServerAccess.callURL(). */ - postURL(urlString: string, parameters?: { onSuccess?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; - onFailure?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; data?: Json; }): void; + postURL( + urlString: string, + parameters?: { + onSuccess?(responseData: string, externalServerResponse: ExternalServerResponse): void; + onFailure?(responseData: string, externalServerResponse: ExternalServerResponse): void; + data?: Json; + }): void; /** * Macht einen GET-Request auf die übergebene URL. Im Gegensatz zum GET-Request wird der Inhalt der Webseite wird nicht ausgelesen. * Aus diesem Grund ist diese Methode schneller. * Diese Methode ist eine Convenience-Methode für externalServerAccess.callURL(). */ - touchURL(urlString: string, parameters?: { onSuccess?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; - onFailure?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; }): void; + touchURL( + urlString: string, + parameters?: { + onSuccess?(responseData: string, externalServerResponse: ExternalServerResponse): void; + onFailure?(responseData: string, externalServerResponse: ExternalServerResponse): void; + }): void; /** * Macht einen Request auf die übergebene URL. */ - callURL(urlString: string, parameters?: { onSuccess?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; - onFailure?: (responseData: string, externalServerResponse: ExternalServerResponse) => void; method?: ("GET" | "POST"); data?: Json; }): void; + callURL( + urlString: string, + parameters?: { + onSuccess?(responseData: string, externalServerResponse: ExternalServerResponse): void; + onFailure?(responseData: string, externalServerResponse: ExternalServerResponse): void; + method?: ("GET" | "POST"); + data?: Json; + }): void; } /** @@ -1308,7 +1327,7 @@ declare class KnuddelAccount { * *

Hinweis: Knuddel an einen Nutzer senden kannst du mit der Methode BotUser/transferKnuddel:method. */ - use(knuddelAmount: KnuddelAmount, displayReasonText: string, parameters?: { transferReason?: string; onError?: (message: string) => void; onSuccess?: () => void; }): void; + use(knuddelAmount: KnuddelAmount, displayReasonText: string, parameters?: { transferReason?: string; onError?(message: string): void; onSuccess?(): void; }): void; } /** @@ -1590,7 +1609,13 @@ declare class KnuddelsServer { * Ist ein KnuddelPot 30 Minuten nach dem Erzeugen noch nicht gesealt, * so wird vom Server automatisch ein KnuddelPot/refund:method ausgelöst. */ - static createKnuddelPot(knuddelAmount: KnuddelAmount, params?: { payoutTimeoutMinutes?: number; shouldSealPot?: (pot: KnuddelPot) => boolean; onPotSealed?: (pot: KnuddelPot) => void; }): KnuddelPot; + static createKnuddelPot( + knuddelAmount: KnuddelAmount, + params?: { + payoutTimeoutMinutes?: number; + shouldSealPot?(pot: KnuddelPot): boolean; + onPotSealed?(pot: KnuddelPot): void; + }): KnuddelPot; /** * Liefert den KnuddelPot mit der angegeben id. */ @@ -2466,8 +2491,10 @@ declare class UserAccess { */ eachAccessibleUser( callback: (user: User, index: number, accessibleUserCount: number, key?: string) => boolean, - parameters?: { onStart?: (accessibleUserCount: number, key?: string) => void; - onEnd?: (accessibleUserCount: number, key?: string) => void; }): void; + parameters?: { + onStart?(accessibleUserCount: number, key?: string): void; + onEnd?(accessibleUserCount: number, key?: string): void; + }): void; } /** @@ -2589,8 +2616,8 @@ declare class UserPersistenceNumbers { minimumValue?: number; maximumValue?: number; maximumCount?: number; - onStart?: (totalCount: number, key: string) => void; - onEnd?: (totalCount: number, key: string) => void; + onStart?(totalCount: number, key: string): void; + onEnd?(totalCount: number, key: string): void; }): void; /** * Liefert alle keys, die für User in der Persistence diff --git a/types/knuddels-userapps-api/knuddels-userapps-api-tests.ts b/types/knuddels-userapps-api/knuddels-userapps-api-tests.ts index dadd8b93b6..e768240b52 100644 --- a/types/knuddels-userapps-api/knuddels-userapps-api-tests.ts +++ b/types/knuddels-userapps-api/knuddels-userapps-api-tests.ts @@ -11,14 +11,14 @@ class Server implements App { .forEach((user) => { this.onUserJoined(user); }); - }; + } onUserJoined(user: User) { const botNick = KnuddelsServer.getDefaultBotUser() .getNick() .escapeKCode(); user.sendPrivateMessage('Lust auf ne Runde Ziegenphobie? Mit nur _°BB>_h1 Knuddel|/appknuddel ' + botNick + '<°°°_ bist du dabei!'); - }; + } onUserLeft(user: User) { if (this.usersPlaying[user.getNick()] === 1) { @@ -27,7 +27,7 @@ class Server implements App { delete this.usersPlaying[user.getNick()]; } - }; + } onPrepareShutdown() { if (!this.isShuttingDown) { @@ -71,7 +71,7 @@ class Server implements App { } else { knuddelTransfer.accept(); } - }; + } onKnuddelReceived(user: User, receiver: User, knuddelAmount: KnuddelAmount) { if (knuddelAmount.asNumber() === 1) { @@ -80,7 +80,7 @@ class Server implements App { } else { user.sendPrivateMessage('Vielen Dank für die Einzahlung.'); } - }; + } onEventReceived(user: User, key: string, data: string) { if (key === 'selectedEntry' && this.usersPlaying[user.getNick()] === 1) { @@ -120,7 +120,7 @@ class Server implements App { }, 4000); }, 1500); } - }; + } } declare let App: Server; // tell the compiler that "App" will be available diff --git a/types/koa-compose/koa-compose-tests.ts b/types/koa-compose/koa-compose-tests.ts index 4c12ca6571..ed1c705e5d 100644 --- a/types/koa-compose/koa-compose-tests.ts +++ b/types/koa-compose/koa-compose-tests.ts @@ -3,11 +3,11 @@ import compose = require('koa-compose'); const fn1: compose.Middleware = (context: any, next: () => Promise): Promise => Promise .resolve(console.log('in fn1')) - .then(() => next()); + .then(next); const fn2: compose.Middleware = (context: any, next: () => Promise): Promise => Promise .resolve(console.log('in fn2')) - .then(() => next()); + .then(next); const fn = compose([fn1, fn2]); diff --git a/types/koa-json-error/index.d.ts b/types/koa-json-error/index.d.ts index dfe23c26b0..5fc9618edf 100644 --- a/types/koa-json-error/index.d.ts +++ b/types/koa-json-error/index.d.ts @@ -10,17 +10,17 @@ interface JSONErrorOptions { /** * Perform some task before calling `options.format`. Must be a function with the original err as its only argument. */ - preFormat?: (err: Error) => any; + preFormat?(err: Error): any; /** * Runs inmediatly after `options.preFormat`. It receives two arguments: the original `err` and the output of `options.preFormat`. It should `return` a newly formatted error. */ - format?: (err: Error, obj: any) => any; + format?(err: Error, obj: any): any; /** * Runs inmediatly after `options.format`. It receives two arguments: the original `err` and the output of `options.format`. It should `return` a newly formatted error. */ - postFormat?: (err: Error, obj: any) => any; + postFormat?(err: Error, obj: any): any; } /** diff --git a/types/koa-jwt/index.d.ts b/types/koa-jwt/index.d.ts index ba60bd8e61..a355d44ce2 100644 --- a/types/koa-jwt/index.d.ts +++ b/types/koa-jwt/index.d.ts @@ -13,7 +13,7 @@ declare namespace jwt { interface Options { secret: string | Buffer; key?: string; - getToken?: (opts: jwt.Options) => string; + getToken?(opts: jwt.Options): string; passthrough?: boolean; cookie?: string; debug?: boolean; diff --git a/types/kss/index.d.ts b/types/kss/index.d.ts new file mode 100644 index 0000000000..1a7359c1da --- /dev/null +++ b/types/kss/index.d.ts @@ -0,0 +1,149 @@ +// Type definitions for KSS 3.0.0-beta +// Project: https://github.com/kss-node/kss-node +// Definitions by: Gilad Gray +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** Builds a styleguide given the proper options. */ +declare function kss(options?: kss.KssOptions): Promise; +declare namespace kss { + interface File { + /** bath to source directory */ + base: string; + /** file contents */ + contents: string; + /** full path to file */ + path: string; + } + + interface Source { + /** The name of the file. */ + filename: string; + /** The full path of the file. */ + path: string; + /** The line number where the KSS comment is found. */ + line: number; + } + + interface Options { + /** + * Whether to automatically format Markdown using [marked](https://github.com/chjj/marked). + * Enabled by default. + * @default true + */ + markdown?: boolean; + /** + * Use a regex or string (e.g. `*.less|*.css`) to only parse files matching this value. + * @default *.css|*.less|*.sass|*.scss|*.styl|*.stylus + */ + mask?: string | RegExp; + /** + * kss-node makes the header available separately from the description. To make kss-node + * behave like the Ruby KSS, disable this option and the title will remain a part of the + * description. Enabled by default. + * @default true. + */ + header?: boolean; + } + + interface KssOptions extends Options { + builder?: any; + clone?: boolean; + custom?: any; + logErrorFunction?(...msg: string[]): void; + json?: boolean; + mask?: string | RegExp; + source: string[]; + verbose?: boolean; + } + + type CallbackFn = (error: Error | null, styleguide: KssStyleguide) => void; + + class KssStyleguide { + constructor(data?: any); + autoInit(autoInit: boolean): KssStyleguide; + customPropertyNames(): string[]; + customPropertyNames(names: string | string[]): KssStyleguide; + hasNumericReferences(): boolean; + init(): KssStyleguide; + referenceDelimiter(): string; + sections(): KssSection[]; + sections(query: string | RegExp): false | KssSection | KssSection[]; + sections(sections: KssSection | KssSection[]): KssStyleguide; + toJSON(): any; + } + + class KssSection { + constructor(data?: any); + custom(name: string): any; + custom(name: string, value: any): KssSection; + customPropertyNames(): string[]; + deprecated(): boolean; + deprecated(deprecated: boolean): KssSection; + depth(): number; + depth(depth: number): KssSection; + description(): string; + description(description: string): KssSection; + experimental(): boolean; + experimental(experimental: boolean): KssSection; + header(): string; + header(header: string): KssSection; + markup(): false | string; + markup(markup: string): KssSection; + modifiers(): KssModifier[]; + modifiers(query: number | string): false | KssModifier; + modifiers(modifiers: KssModifier | KssModifier[]): KssSection; + parameters(): KssParameter[]; + parameters(query: number | string): false | KssParameter; + parameters(parameters: KssParameter | KssParameter[]): KssSection; + reference(): string; + reference(reference: string): KssSection; + referenceNumber(): string; + referenceNumber(referenceNumber: string): KssSection; + referenceURI(): string; + referenceURI(referenceURI: string): KssSection; + source(): Source; + source(source: Source): KssSection; + sourceFileName(): string; + sourceLine(): string; + styleGuide(): KssStyleguide; + styleGuide(styleguide: KssStyleguide): KssSection; + toJSON(): any; + weight(): number; + weight(weight: number): KssSection; + } + + class KssModifier { + constructor(data?: any); + className(): string; + className(className: string): KssModifier; + description(): string; + description(description: string): KssModifier; + markup(): string; + markup(markup: string): KssModifier; + name(): string; + name(name: string): KssModifier; + section(): KssSection; + section(section: KssSection): KssModifier; + toJSON(): any; + } + + class KssParameter { + constructor(data?: any); + defaultValue(): string; + description(): string; + description(description: string): KssParameter; + name(): string; + name(name: string): KssParameter; + section(): KssSection; + section(section: KssSection): KssParameter; + toJSON(): any; + } + + /** Parse a string of documented CSS, or an array of file anys with their content. */ + function parse(input: string | File[], options: Options): KssStyleguide; + + /** Traverse a directory, parse its contents, and create a `KssStyleGuide`. */ + function traverse(directory: string | string[], options: Options): Promise; +} + +export = kss; diff --git a/types/kss/kss-tests.ts b/types/kss/kss-tests.ts new file mode 100644 index 0000000000..1ad03a785b --- /dev/null +++ b/types/kss/kss-tests.ts @@ -0,0 +1,10 @@ +import kss = require("kss"); + +kss.traverse("src", { markdown: false }) + .then((styleguide) => styleguide.sections()) + .then((sections) => sections.map((s) => s.toJSON())) + .then((json) => console.log(json)); + +const json = kss.parse("file contents", { header: false }).sections().map((s) => s.toJSON()); + +// both json vars should be the same type diff --git a/types/kss/tsconfig.json b/types/kss/tsconfig.json new file mode 100644 index 0000000000..30cdd58f41 --- /dev/null +++ b/types/kss/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "kss-tests.ts" + ] +} diff --git a/types/kss/tslint.json b/types/kss/tslint.json new file mode 100644 index 0000000000..f9e30021f4 --- /dev/null +++ b/types/kss/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "../tslint.json" +} diff --git a/types/later/index.d.ts b/types/later/index.d.ts index 5dd68ec90a..2e0d4de386 100644 --- a/types/later/index.d.ts +++ b/types/later/index.d.ts @@ -4,9 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace later { - interface ScheduleData { - /** * A list of recurrence information as a composite schedule. */ @@ -25,7 +23,6 @@ declare namespace later { } interface Recurrence { - /** Time in seconds from midnight. */ t?: number[]; @@ -142,11 +139,10 @@ declare namespace later { * For acces to custom time periods created as extension to the later static type * and modifiers created on the later modifier static type. */ - [ timeperiodAndModifierName: string ]: number[] | undefined; + [timeperiodAndModifierName: string]: number[] | undefined; } interface ParseStatic { - /** * Create a recurrence builder for building schedule data. */ @@ -168,7 +164,6 @@ declare namespace later { } interface Timer { - /** * Clear the timer and end execution. */ @@ -176,58 +171,56 @@ declare namespace later { } interface Schedule { - /** - * Finds the next valid instance or instances of the current schedule, - * optionally between a specified start and end date. Start date is - * Date.now() by default, end date is unspecified. Start date must be - * smaller than end date. - * - * @param {number} numberOfInst: The number of instances to return - * @param {Date} dateFrom: The earliest a valid instance can occur - * @param {Date} dateTo: The latest a valid instance can occur - */ + * Finds the next valid instance or instances of the current schedule, + * optionally between a specified start and end date. Start date is + * Date.now() by default, end date is unspecified. Start date must be + * smaller than end date. + * + * @param {number} numberOfInst: The number of instances to return + * @param {Date} dateFrom: The earliest a valid instance can occur + * @param {Date} dateTo: The latest a valid instance can occur + */ next(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[]; /** - * Finds the next valid range or ranges of the current schedule, - * optionally between a specified start and end date. Start date is - * Date.now() by default, end date is unspecified. Start date must be - * greater than end date. - * - * @param {number} numberOfInst: The number of ranges to return - * @param {Date} dateFrom: The earliest a valid range can occur - * @param {Date} dateTo: The latest a valid range can occur - */ + * Finds the next valid range or ranges of the current schedule, + * optionally between a specified start and end date. Start date is + * Date.now() by default, end date is unspecified. Start date must be + * greater than end date. + * + * @param {number} numberOfInst: The number of ranges to return + * @param {Date} dateFrom: The earliest a valid range can occur + * @param {Date} dateTo: The latest a valid range can occur + */ nextRange(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[]; /** - * Finds the previous valid instance or instances of the current schedule, - * optionally between a specified start and end date. Start date is - * Date.now() by default, end date is unspecified. Start date must be - * greater than end date. - * - * @param {number} numberOfInst: The number of instances to return - * @param {Date} dateFrom: The earliest a valid instance can occur - * @param {Date} dateTo: The latest a valid instance can occur - */ + * Finds the previous valid instance or instances of the current schedule, + * optionally between a specified start and end date. Start date is + * Date.now() by default, end date is unspecified. Start date must be + * greater than end date. + * + * @param {number} numberOfInst: The number of instances to return + * @param {Date} dateFrom: The earliest a valid instance can occur + * @param {Date} dateTo: The latest a valid instance can occur + */ prev(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[]; /** - * Finds the previous valid range or ranges of the current schedule, - * optionally between a specified start and end date. Start date is - * Date.now() by default, end date is unspecified. Start date must be - * greater than end date. - * - * @param {number} numberOfInst: The number of ranges to return - * @param {Date} dateFrom: The earliest a valid range can occur - * @param {Date} dateTo: The latest a valid range can occur - */ + * Finds the previous valid range or ranges of the current schedule, + * optionally between a specified start and end date. Start date is + * Date.now() by default, end date is unspecified. Start date must be + * greater than end date. + * + * @param {number} numberOfInst: The number of ranges to return + * @param {Date} dateFrom: The earliest a valid range can occur + * @param {Date} dateTo: The latest a valid range can occur + */ prevRange(numberOfInst: number, dateFrom?: Date, dateTo?: Date): Date[]; } interface RecurrenceBuilder extends ScheduleData { - /** a time period */ second(): RecurrenceBuilder; @@ -268,7 +261,6 @@ declare namespace later { /** a time period */ fullDate(): RecurrenceBuilder; - /** * Specifies one or more specific vals of a time period information provider. * When used to specify a time, a string indicating the 24-hour time may be used. @@ -371,7 +363,6 @@ declare namespace later { } interface DateProvider { - /** * Set later to use UTC time. */ @@ -434,7 +425,6 @@ declare namespace later { } interface TimePeriod { - /** * The name of the time period information provider. */ @@ -515,7 +505,6 @@ declare namespace later { } interface ModifierStatic { - /** * After Modifier */ @@ -528,7 +517,6 @@ declare namespace later { } interface Static { - /** * Schedule * Generates instances from schedule data. diff --git a/types/later/later-tests.ts b/types/later/later-tests.ts index 1ecd1d6d0e..ea21977c5b 100644 --- a/types/later/later-tests.ts +++ b/types/later/later-tests.ts @@ -1,16 +1,15 @@ import later = require("later"); namespace LaterTest_DefineSchedule { - // define a new schedule - var textSched = later.parse.text('at 10:15am every weekday'); - var cronSched = later.parse.cron('0 0/5 14,18 * * ?'); - var recurSched = later.parse.recur().last().dayOfMonth(); - var manualSched = { schedules: [ { M: [ 3 ], D: [ 21 ] } ] }; + const textSched = later.parse.text('at 10:15am every weekday'); + const cronSched = later.parse.cron('0 0/5 14,18 * * ?'); + const recurSched = later.parse.recur().last().dayOfMonth(); + const manualSched = { schedules: [ { M: [ 3 ], D: [ 21 ] } ] }; // this schedule will fire on the closest weekday to the 15th // every month at 2:00 am except in March - var complexSched = later.parse.recur() + const complexSched = later.parse.recur() .on(15).dayOfMonth().onWeekday().on(2).hour() .and() .on(14).dayOfMonth().on(6).dayOfWeek().on(2).hour() @@ -21,7 +20,6 @@ namespace LaterTest_DefineSchedule { } namespace LaterTest_ConfigureTimezone { - // set later to use UTC (the default) later.date.UTC(); @@ -31,7 +29,7 @@ namespace LaterTest_ConfigureTimezone { namespace LaterTest_TimePeriods { export function second() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.second.name; // 'second' @@ -62,7 +60,7 @@ namespace LaterTest_TimePeriods { } export function minute() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.minute.name; // 'minute' @@ -93,7 +91,7 @@ namespace LaterTest_TimePeriods { } export function hour() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.hour.name; // 'hour' @@ -124,7 +122,7 @@ namespace LaterTest_TimePeriods { } export function time() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.time.name; // 'time' @@ -155,7 +153,7 @@ namespace LaterTest_TimePeriods { } export function day() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.day.name; // 'day' @@ -186,7 +184,7 @@ namespace LaterTest_TimePeriods { } export function day_of_week() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.dayOfWeek.name; // 'day of week' @@ -217,7 +215,7 @@ namespace LaterTest_TimePeriods { } export function day_of_week_count() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.dayOfWeekCount.name; // 'day of week count' @@ -252,7 +250,7 @@ namespace LaterTest_TimePeriods { } export function day_of_year() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.dayOfYear.name; // 'day of year' @@ -283,7 +281,7 @@ namespace LaterTest_TimePeriods { } export function week_of_month() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.weekOfMonth.name; // 'week of month' @@ -314,7 +312,7 @@ namespace LaterTest_TimePeriods { } export function week_of_year() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.weekOfYear.name; // 'week of year' @@ -345,7 +343,7 @@ namespace LaterTest_TimePeriods { } export function month() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.month.name; // 'month' @@ -376,7 +374,7 @@ namespace LaterTest_TimePeriods { } export function year() { - var d = new Date('2013-03-22T10:02:05Z'); + const d = new Date('2013-03-22T10:02:05Z'); later.year.name; // 'year' @@ -411,11 +409,9 @@ namespace LaterTest_TimePeriods { } export function custom() { - - var customLater = later; + const customLater = later; customLater.partOfDay = { - name: 'part of day', range: later.hour.range * 6, @@ -437,7 +433,7 @@ namespace LaterTest_TimePeriods { }, start(date: Date) { - var hour = customLater.partOfDay.val(date) === 0 + const hour = customLater.partOfDay.val(date) === 0 ? 0 : customLater.partOfDay.val(date) === 1 ? 12 @@ -452,7 +448,7 @@ namespace LaterTest_TimePeriods { }, end(date: Date) { - var hour = customLater.partOfDay.val(date) === 0 + const hour = customLater.partOfDay.val(date) === 0 ? 11 : customLater.partOfDay.val(date) === 1 ? 5 @@ -467,7 +463,7 @@ namespace LaterTest_TimePeriods { }, next(date: Date, val: any) { - var hour = val === 0 + const hour = val === 0 ? 0 : val === 1 ? 12 @@ -483,7 +479,7 @@ namespace LaterTest_TimePeriods { }, prev(date: Date, val: any) { - var hour = val === 0 + const hour = val === 0 ? 11 : val === 1 ? 5 @@ -502,7 +498,6 @@ namespace LaterTest_TimePeriods { } namespace LaterTest_GenerateRecurences { - export function on_method() { // fires on the 2nd minute every hour later.parse.recur().on(2).minute(); @@ -575,7 +570,7 @@ namespace LaterTest_GenerateRecurences { export function and_method() { // fires every 2 hours on the first day of every month // and 8:00am and 8:00pm on the last day of every month - var sched = later.parse.recur() + const sched = later.parse.recur() .every(2).hour().first().dayOfMonth() .and() .on(8, 20).hour().last().dayOfMonth(); @@ -583,42 +578,39 @@ namespace LaterTest_GenerateRecurences { export function except_method() { // fires every minute of every hour except on multiples of 2 and 3 - var sched = later.parse.recur() + const sched = later.parse.recur() .every().minute() .except() .every(2).minute().between(2, 59) .and() .every(3).minute().between(3, 59); } - } namespace LaterTest_CalculateOccurences { - // Initialise next variable. - var next: Date[] = []; + let next: Date[] = []; // calculate the next 10 occurrences of a recur schedule - var recurSched = later.parse.recur().last().dayOfMonth(); + const recurSched = later.parse.recur().last().dayOfMonth(); next = later.schedule(recurSched).next(10); // calculate the previous occurrence starting from March 21, 2013 - var cronSched = later.parse.cron('0 0/5 14,18 * * ?'); + const cronSched = later.parse.cron('0 0/5 14,18 * * ?'); next = later.schedule(cronSched).prev(1, new Date(2013, 2, 21)); } namespace LaterTest_ExecuteCodeUsingSchedule { - // will fire every 5 minutes - var textSched = later.parse.text('every 5 min'); + const textSched = later.parse.text('every 5 min'); // execute logTime one time on the next occurrence of the text schedule - var timer = later.setTimeout(logTime, textSched); + const timer = later.setTimeout(logTime, textSched); // execute logTime for each successive occurrence of the text schedule - var timer2 = later.setInterval(logTime, textSched); + const timer2 = later.setInterval(logTime, textSched); // function to execute function logTime() { diff --git a/types/leaflet-draw/leaflet-draw-tests.ts b/types/leaflet-draw/leaflet-draw-tests.ts index 9729747851..05f1a2db6a 100644 --- a/types/leaflet-draw/leaflet-draw-tests.ts +++ b/types/leaflet-draw/leaflet-draw-tests.ts @@ -1,7 +1,7 @@ -const osmUrl = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', - osmAttrib = '© OpenStreetMap contributors', - osm = L.tileLayer(osmUrl, {maxZoom: 18, attribution: osmAttrib}), - map = L.map('map', {layers: [osm], center: L.latLng(-37.7772, 175.2756), zoom: 15 }); +const osmUrl = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'; +const osmAttrib = '© OpenStreetMap contributors'; +const osm = L.tileLayer(osmUrl, {maxZoom: 18, attribution: osmAttrib}); +const map = L.map('map', {layers: [osm], center: L.latLng(-37.7772, 175.2756), zoom: 15 }); const drawnItems = L.featureGroup(); map.addLayer(drawnItems); @@ -37,8 +37,8 @@ map.addControl(drawControl); map.on('draw:created', (e: any) => { const drawEvent = e as L.DrawEvents.Created; - const type = drawEvent.layerType, - layer = drawEvent.layer; + const type = drawEvent.layerType; + const layer = drawEvent.layer; drawnItems.addLayer(layer); }); diff --git a/types/leaflet-fullscreen/index.d.ts b/types/leaflet-fullscreen/index.d.ts index 5051af1f60..168fae8a28 100644 --- a/types/leaflet-fullscreen/index.d.ts +++ b/types/leaflet-fullscreen/index.d.ts @@ -7,6 +7,6 @@ declare namespace L { interface MapOptions { - fullscreenControl?: true | {pseudoFullscreen: boolean} + fullscreenControl?: true | {pseudoFullscreen: boolean}; } } diff --git a/types/leaflet-fullscreen/leaflet-fullscreen-tests.ts b/types/leaflet-fullscreen/leaflet-fullscreen-tests.ts index d016d2eea5..661f1bc208 100644 --- a/types/leaflet-fullscreen/leaflet-fullscreen-tests.ts +++ b/types/leaflet-fullscreen/leaflet-fullscreen-tests.ts @@ -1,5 +1,5 @@ -var map = L.map('map', { +const map = L.map('map', { center: [51.505, -0.09], zoom: 13, fullscreenControl: true, -}); \ No newline at end of file +}); diff --git a/types/leaflet.locatecontrol/index.d.ts b/types/leaflet.locatecontrol/index.d.ts index 3f4d94e9ce..7692c2bb60 100644 --- a/types/leaflet.locatecontrol/index.d.ts +++ b/types/leaflet.locatecontrol/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Leaflet.locate 0.60 +// Type definitions for leaflet.locatecontrol 0.60 // Project: https://github.com/domoritz/leaflet-locatecontrol // Definitions by: Denis Carriere // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -7,39 +7,37 @@ declare namespace L { namespace Control { - export interface Locate extends L.Control {} - export interface LocateOptions { - position?: string - layer?: L.Layer - setView?: boolean | string - flyTo?: boolean - keepCurrentZoomLevel?: boolean - clickBehavior?: any - returnToPrevBounds?: boolean - cacheLocation?: boolean - drawCircle?: boolean - drawMarker?: boolean - markerClass?: any - circleStyle?: L.PathOptions - markerStyle?: L.PathOptions - followCircleStyle?: L.PathOptions - followMarkerStyle?: L.PathOptions - icon?: string - iconLoading?: string - iconElementTag?: string - circlePadding?: number[] - onLocationError?: any - onLocationOutsideMapBounds?: any - showPopup?: boolean - strings?: any - locateOptions?: L.LocateOptions + interface LocateOptions { + position?: string; + layer?: L.Layer; + setView?: boolean | string; + flyTo?: boolean; + keepCurrentZoomLevel?: boolean; + clickBehavior?: any; + returnToPrevBounds?: boolean; + cacheLocation?: boolean; + drawCircle?: boolean; + drawMarker?: boolean; + markerClass?: any; + circleStyle?: L.PathOptions; + markerStyle?: L.PathOptions; + followCircleStyle?: L.PathOptions; + followMarkerStyle?: L.PathOptions; + icon?: string; + iconLoading?: string; + iconElementTag?: string; + circlePadding?: number[]; + onLocationError?: any; + onLocationOutsideMapBounds?: any; + showPopup?: boolean; + strings?: any; + locateOptions?: L.LocateOptions; } } - namespace control { /** - * Creates a Leaflet.Locate control - */ - export function locate(options?: Control.LocateOptions): L.Control.Locate; + * Creates a Leaflet.Locate control + */ + function locate(options?: Control.LocateOptions): L.Control; } } diff --git a/types/leaflet.locatecontrol/leaflet.locatecontrol-tests.ts b/types/leaflet.locatecontrol/leaflet.locatecontrol-tests.ts index 40fc41142f..59ab7f246f 100644 --- a/types/leaflet.locatecontrol/leaflet.locatecontrol-tests.ts +++ b/types/leaflet.locatecontrol/leaflet.locatecontrol-tests.ts @@ -1,4 +1,4 @@ -var map = L.map('map', { +const map = L.map('map', { center: [51.505, -0.09], zoom: 13 }); @@ -7,7 +7,7 @@ var map = L.map('map', { L.control.locate().addTo(map); // Simple -var lc = L.control.locate({ +const lc = L.control.locate({ position: 'topright', strings: { title: "Show me where I am, yo!" @@ -19,4 +19,4 @@ map.addControl(L.control.locate({ locateOptions: { maxZoom: 10, enableHighAccuracy: true -}})); \ No newline at end of file +}})); diff --git a/types/leaflet/index.d.ts b/types/leaflet/index.d.ts index 0efffe8f9e..043a8eabe9 100644 --- a/types/leaflet/index.d.ts +++ b/types/leaflet/index.d.ts @@ -49,7 +49,7 @@ declare namespace L { function clipPolygon(points: Point[], bounds: BoundsExpression, round?: boolean): Point[]; } - module DomUtil { + namespace DomUtil { /** * Get Element by its ID or with the given HTML-Element */ @@ -796,7 +796,7 @@ declare namespace L { * } * ``` */ - pointToLayer?: (geoJsonPoint: GeoJSONFeature, latlng: LatLng) => Layer; // should import GeoJSON typings + pointToLayer?(geoJsonPoint: GeoJSONFeature, latlng: LatLng): Layer; // should import GeoJSON typings /** * A Function defining the Path options for styling GeoJSON lines and polygons, @@ -822,7 +822,7 @@ declare namespace L { * function (feature, layer) {} * ``` */ - onEachFeature?: (feature: GeoJSONFeature, layer: Layer) => void; + onEachFeature?(feature: GeoJSONFeature, layer: Layer): void; /** * A Function that will be used to decide whether to show a feature or not. @@ -835,13 +835,13 @@ declare namespace L { * } * ``` */ - filter?: (geoJsonFeature: GeoJSONFeature) => boolean; + filter?(geoJsonFeature: GeoJSONFeature): boolean; /** * A Function that will be used for converting GeoJSON coordinates to LatLngs. * The default is the coordsToLatLng static method. */ - coordsToLatLng?: (coords: [number, number] | [number, number, number]) => LatLng; // check if LatLng has an altitude property + coordsToLatLng?(coords: [number, number] | [number, number, number]): LatLng; // check if LatLng has an altitude property } /** diff --git a/types/left-pad/index.d.ts b/types/left-pad/index.d.ts index 86996ccd47..ce8bc5237d 100644 --- a/types/left-pad/index.d.ts +++ b/types/left-pad/index.d.ts @@ -5,4 +5,4 @@ declare function leftPad(str: string|number, len: number, ch?: string|number): string; -export = leftPad; \ No newline at end of file +export = leftPad; diff --git a/types/left-pad/left-pad-tests.ts b/types/left-pad/left-pad-tests.ts index 53a08d1a9a..a3749feb16 100644 --- a/types/left-pad/left-pad-tests.ts +++ b/types/left-pad/left-pad-tests.ts @@ -12,4 +12,4 @@ leftPad(1, 2, "0"); // => "01" leftPad(17, 5, 0); -// => "00017" \ No newline at end of file +// => "00017" diff --git a/types/libpq/index.d.ts b/types/libpq/index.d.ts index 76bfb40935..49c00db818 100644 --- a/types/libpq/index.d.ts +++ b/types/libpq/index.d.ts @@ -102,7 +102,7 @@ declare class Libpq extends EventEmitter { * @returns {boolean} true if data was read; false if there was an error. You can access * error details with [[Libpq.errorMessage]]. */ - consumeInput(): boolean + consumeInput(): boolean; /** * Retrieves the last error message from the connection. This is intended to be used after most diff --git a/types/linkify-it/index.d.ts b/types/linkify-it/index.d.ts index 00b564bff6..ae57d1c3e9 100644 --- a/types/linkify-it/index.d.ts +++ b/types/linkify-it/index.d.ts @@ -9,24 +9,24 @@ declare const LinkifyIt: { }; declare namespace LinkifyIt { - export interface FullRule { - validate: (text: string, pos: number, self: LinkifyIt) => number; - normalize?: (match: string) => string; + interface FullRule { + validate(text: string, pos: number, self: LinkifyIt): number; + normalize?(match: string): string; } - export type Rule = string | RegExp | FullRule; + type Rule = string | RegExp | FullRule; - export interface SchemaRules { + interface SchemaRules { [schema: string]: Rule; } - export interface Options { + interface Options { fuzzyLink?: boolean; fuzzyIP?: boolean; fuzzyEmail?: boolean; } - export interface Match { + interface Match { index: number; lastIndex: number; raw: string; @@ -35,7 +35,7 @@ declare namespace LinkifyIt { url: string; } - export interface LinkifyIt { + interface LinkifyIt { add(schema: string, rule: Rule): LinkifyIt; match(text: string): Match[]; normalize(raw: string): string; diff --git a/types/lodash.zipobjectdeep/index.d.ts b/types/lodash.zipobjectdeep/index.d.ts new file mode 100644 index 0000000000..1944588188 --- /dev/null +++ b/types/lodash.zipobjectdeep/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for lodash.zipObjectDeep 4.1 +// Project: http://lodash.com/ +// Definitions by: Brian Zengel , Ilya Mochalov , Stepan Mikhaylyuk +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +import { zipObjectDeep } from "lodash"; +export = zipObjectDeep; diff --git a/types/lodash.zipobjectdeep/tsconfig.json b/types/lodash.zipobjectdeep/tsconfig.json new file mode 100644 index 0000000000..92ebbc6458 --- /dev/null +++ b/types/lodash.zipobjectdeep/tsconfig.json @@ -0,0 +1,21 @@ +{ + "files": [ + "index.d.ts" + ], + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + } +} \ No newline at end of file diff --git a/types/lodash.zipobjectdeep/tslint.json b/types/lodash.zipobjectdeep/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/lodash.zipobjectdeep/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } diff --git a/types/lodash/index.d.ts b/types/lodash/index.d.ts index 39dad36ed5..f3dac0b006 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -5654,9 +5654,8 @@ declare namespace _ { //_.zipObject interface LoDashStatic { /** - * The inverse of _.pairs; this method returns an object composed from arrays of property names and values. - * Provide either a single two dimensional array, e.g. [[key1, value1], [key2, value2]] or two arrays, one of - * property names and one of corresponding values. + * This method is like _.fromPairs except that it accepts two arrays, one of property + * identifiers and one of corresponding values. * * @param props The property names. * @param values The property values. @@ -5666,6 +5665,17 @@ declare namespace _ { props: List|List>, values?: List ): TResult; + /** + * This method is like _.zipObject except that it supports property paths. + * + * @param props The property names. + * @param values The property values. + * @return Returns the new object. + */ + zipObjectDeep( + props: List|List>, + values?: List + ): TResult; /** * @see _.zipObject @@ -5674,6 +5684,13 @@ declare namespace _ { props: List|List>, values?: List ): TResult; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + props: List|List>, + values?: List + ): TResult; /** * @see _.zipObject @@ -5682,6 +5699,13 @@ declare namespace _ { props: List|List>, values?: List ): _.Dictionary; + /** + * @see _.zipObjectDeep + */ + zipObjectDepp( + props: List|List>, + values?: List + ): _.Dictionary; } interface LoDashImplicitArrayWrapper { @@ -5691,6 +5715,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5698,6 +5728,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5705,6 +5741,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper<_.Dictionary>; } interface LoDashImplicitObjectWrapper { @@ -5714,6 +5756,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5721,6 +5769,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5728,6 +5782,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper<_.Dictionary>; } interface LoDashExplicitArrayWrapper { @@ -5737,6 +5797,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5744,6 +5810,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5751,6 +5823,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper<_.Dictionary>; } interface LoDashExplicitObjectWrapper { @@ -5760,6 +5838,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5767,6 +5851,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5774,6 +5864,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper<_.Dictionary>; } //_.zipWith @@ -16978,23 +17074,23 @@ declare namespace _ { * @param object The object to query. * @return Returns the new array of key-value pairs. */ - toPairs(object?: T): any[][]; + toPairs(object?: T): [string, any][]; - toPairs(object?: T): TResult[][]; + toPairs(object?: T): [string, TResult][]; } interface LoDashImplicitObjectWrapper { /** * @see _.toPairs */ - toPairs(): LoDashImplicitArrayWrapper; + toPairs(): LoDashImplicitArrayWrapper<[string, TResult]>; } interface LoDashExplicitObjectWrapper { /** * @see _.toPairs */ - toPairs(): LoDashExplicitArrayWrapper; + toPairs(): LoDashExplicitArrayWrapper<[string, TResult]>; } //_.toPairsIn @@ -17005,23 +17101,23 @@ declare namespace _ { * @param object The object to query. * @return Returns the new array of key-value pairs. */ - toPairsIn(object?: T): any[][]; + toPairsIn(object?: T): [string, any][]; - toPairsIn(object?: T): TResult[][]; + toPairsIn(object?: T): [string, TResult][]; } interface LoDashImplicitObjectWrapper { /** * @see _.toPairsIn */ - toPairsIn(): LoDashImplicitArrayWrapper; + toPairsIn(): LoDashImplicitArrayWrapper<[string, TResult]>; } interface LoDashExplicitObjectWrapper { /** * @see _.toPairsIn */ - toPairsIn(): LoDashExplicitArrayWrapper; + toPairsIn(): LoDashExplicitArrayWrapper<[string, TResult]>; } //_.transform diff --git a/types/lodash/lodash-tests.ts b/types/lodash/lodash-tests.ts index a168825dad..470bb1338c 100644 --- a/types/lodash/lodash-tests.ts +++ b/types/lodash/lodash-tests.ts @@ -2601,12 +2601,18 @@ namespace TestZipObject { let result: _.Dictionary; result = _.zipObject(arrayOfKeys); + result = _.zipObjectDeep(arrayOfKeys); result = _.zipObject(arrayOfKeys, arrayOfValues); + result = _.zipObjectDeep(arrayOfKeys, arrayOfValues); result = _.zipObject(arrayOfKeys, listOfValues); + result = _.zipObjectDeep(arrayOfKeys, listOfValues); result = _.zipObject(listOfKeys); + result = _.zipObjectDeep(listOfKeys); result = _.zipObject(listOfKeys, listOfValues); + result = _.zipObjectDeep(listOfKeys, listOfValues); result = _.zipObject(listOfKeys, arrayOfValues); + result = _.zipObjectDeep(listOfKeys, arrayOfValues); result = _.zipObject<_.Dictionary>(arrayOfKeyValuePairs); result = _.zipObject<_.Dictionary>(listOfKeyValuePairs); @@ -2640,15 +2646,23 @@ namespace TestZipObject { let result: _.LoDashImplicitObjectWrapper<_.Dictionary>; result = _(arrayOfKeys).zipObject(); + result = _(arrayOfKeys).zipObjectDeep(); result = _(arrayOfKeys).zipObject(arrayOfValues); + result = _(arrayOfKeys).zipObjectDeep(arrayOfValues); result = _(arrayOfKeys).zipObject(listOfValues); + result = _(arrayOfKeys).zipObjectDeep(listOfValues); result = _(listOfKeys).zipObject(); + result = _(listOfKeys).zipObjectDeep(); result = _(listOfKeys).zipObject(listOfValues); + result = _(listOfKeys).zipObjectDeep(listOfValues); result = _(listOfKeys).zipObject(arrayOfValues); + result = _(listOfKeys).zipObjectDeep(arrayOfValues); result = _(listOfKeys).zipObject(arrayOfKeyValuePairs); + result = _(listOfKeys).zipObjectDeep(arrayOfKeyValuePairs); result = _(listOfKeys).zipObject(listOfKeyValuePairs); + result = _(listOfKeys).zipObjectDeep(listOfKeyValuePairs); } { @@ -2679,15 +2693,23 @@ namespace TestZipObject { let result: _.LoDashExplicitObjectWrapper<_.Dictionary>; result = _(arrayOfKeys).chain().zipObject(); + result = _(arrayOfKeys).chain().zipObjectDeep(); result = _(arrayOfKeys).chain().zipObject(arrayOfValues); + result = _(arrayOfKeys).chain().zipObjectDeep(arrayOfValues); result = _(arrayOfKeys).chain().zipObject(listOfValues); + result = _(arrayOfKeys).chain().zipObjectDeep(listOfValues); result = _(listOfKeys).chain().zipObject(); + result = _(listOfKeys).chain().zipObjectDeep(); result = _(listOfKeys).chain().zipObject(listOfValues); + result = _(listOfKeys).chain().zipObjectDeep(listOfValues); result = _(listOfKeys).chain().zipObject(arrayOfValues); + result = _(listOfKeys).chain().zipObjectDeep(arrayOfValues); result = _(listOfKeys).chain().zipObject(arrayOfKeyValuePairs); + result = _(listOfKeys).chain().zipObjectDeep(arrayOfKeyValuePairs); result = _(listOfKeys).chain().zipObject(listOfKeyValuePairs); + result = _(listOfKeys).chain().zipObjectDeep(listOfKeyValuePairs); } } @@ -10152,37 +10174,37 @@ namespace TestToPairs { let object: _.Dictionary; { - let result: any[][]; + let result: [string, any][]; result = _.toPairs<_.Dictionary>(object); } { - let result: string[][]; + let result: [string, string][]; result = _.toPairs<_.Dictionary, string>(object); } { - let result: _.LoDashImplicitArrayWrapper; + let result: _.LoDashImplicitArrayWrapper<[string, string]>; result = _(object).toPairs(); } { - let result: _.LoDashImplicitArrayWrapper; + let result: _.LoDashImplicitArrayWrapper<[string, any]>; result = _(object).toPairs(); } { - let result: _.LoDashExplicitArrayWrapper; + let result: _.LoDashExplicitArrayWrapper<[string, string]>; result = _(object).chain().toPairs(); } { - let result: _.LoDashExplicitArrayWrapper; + let result: _.LoDashExplicitArrayWrapper<[string, any]>; result = _(object).chain().toPairs(); } @@ -10193,37 +10215,37 @@ namespace TestToPairsIn { let object: _.Dictionary; { - let result: any[][]; + let result: [string, any][]; result = _.toPairsIn<_.Dictionary>(object); } { - let result: string[][]; + let result: [string, string][]; result = _.toPairsIn<_.Dictionary, string>(object); } { - let result: _.LoDashImplicitArrayWrapper; + let result: _.LoDashImplicitArrayWrapper<[string, string]>; result = _(object).toPairsIn(); } { - let result: _.LoDashImplicitArrayWrapper; + let result: _.LoDashImplicitArrayWrapper<[string, any]>; result = _(object).toPairsIn(); } { - let result: _.LoDashExplicitArrayWrapper; + let result: _.LoDashExplicitArrayWrapper<[string, string]>; result = _(object).chain().toPairsIn(); } { - let result: _.LoDashExplicitArrayWrapper; + let result: _.LoDashExplicitArrayWrapper<[string, any]>; result = _(object).chain().toPairs(); } diff --git a/types/lodash/tsconfig.json b/types/lodash/tsconfig.json index 419b6142b1..c0730d6661 100644 --- a/types/lodash/tsconfig.json +++ b/types/lodash/tsconfig.json @@ -288,6 +288,7 @@ "xorWith/index.d.ts", "zip/index.d.ts", "zipObject/index.d.ts", + "zipObjectDeep/index.d.ts", "zipWith/index.d.ts" ], "compilerOptions": { diff --git a/types/lodash/tslint.json b/types/lodash/tslint.json index 7805e0387d..7e8d4b911a 100644 --- a/types/lodash/tslint.json +++ b/types/lodash/tslint.json @@ -1,16 +1,22 @@ { "extends": "../tslint.json", "rules": { + "adjacent-overload-signatures": false, + "align": false, "array-type": false, + "ban-types": false, "callable-types": false, "comment-format": false, - "ban-types": false, + "eofline": false, "interface-name": false, "interface-over-type-literal": false, + "jsdoc-format": false, "max-line-length": false, "no-empty-interface": false, + "no-trailing-whitespace": false, "object-literal-key-quotes": false, "one-line": false, + "one-variable-per-declaration": false, "prefer-const": false, "semicolon": false, "triple-equals": false, diff --git a/types/lodash/zipObjectDeep/index.d.ts b/types/lodash/zipObjectDeep/index.d.ts new file mode 100644 index 0000000000..a155901bb5 --- /dev/null +++ b/types/lodash/zipObjectDeep/index.d.ts @@ -0,0 +1,2 @@ +import { zipObjectDeep } from "../index"; +export = zipObjectDeep; \ No newline at end of file diff --git a/types/loopback-boot/index.d.ts b/types/loopback-boot/index.d.ts index 93e912363e..89414d5a4c 100644 --- a/types/loopback-boot/index.d.ts +++ b/types/loopback-boot/index.d.ts @@ -185,7 +185,6 @@ interface OptionsLB { } declare namespace lb { - /** * compileToBrowserify * @@ -197,7 +196,6 @@ declare namespace lb { */ class compileToBrowserify { - /** * Application identifier used to load the correct boot configuration when * building multiple applications using browserify. @@ -207,4 +205,4 @@ declare namespace lb { } } -export = lb; \ No newline at end of file +export = lb; diff --git a/types/loopback-boot/loopback-boot-tests.ts b/types/loopback-boot/loopback-boot-tests.ts index 4885fca1d0..5b0e8d54a9 100644 --- a/types/loopback-boot/loopback-boot-tests.ts +++ b/types/loopback-boot/loopback-boot-tests.ts @@ -25,4 +25,4 @@ class Server { this.app.start(); }); } -} \ No newline at end of file +} diff --git a/types/lorem-ipsum/index.d.ts b/types/lorem-ipsum/index.d.ts index 0a2210c0d8..a4252de442 100644 --- a/types/lorem-ipsum/index.d.ts +++ b/types/lorem-ipsum/index.d.ts @@ -47,7 +47,7 @@ interface LoremIpsumOptions { /** * A PRNG function. Uses Math.random by default. */ - random?: () => number; + random?(): number; /** * The character to insert between paragraphs. Defaults to default EOL. diff --git a/types/ltx/index.d.ts b/types/ltx/index.d.ts index c5794f12bb..b466521876 100644 --- a/types/ltx/index.d.ts +++ b/types/ltx/index.d.ts @@ -4,7 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 -export {Element} from './lib/Element' +export {Element} from './lib/Element'; export {nameEqual, attrsEqual, childrenEqual, equal} from './lib/equal'; export {isNode, isElement, isText} from './lib/is'; export {clone} from './lib/clone'; diff --git a/types/lz-string/index.d.ts b/types/lz-string/index.d.ts index 3baaee4037..bd64854976 100644 --- a/types/lz-string/index.d.ts +++ b/types/lz-string/index.d.ts @@ -9,85 +9,85 @@ export as namespace LZString; declare namespace LZString { /** - * LZ-based compression algorithm for JavaScript. - */ + * LZ-based compression algorithm for JavaScript. + */ interface LZStringStatic { /** - * Compresses input string producing an instance of an "invalid" UTF-16 string. - * Such string could be stored in localStorage only on webkit - * browsers (tested on Android, Chrome, Safari). - * - * @param uncompressed A string which should be compressed. - */ + * Compresses input string producing an instance of an "invalid" UTF-16 string. + * Such string could be stored in localStorage only on webkit + * browsers (tested on Android, Chrome, Safari). + * + * @param uncompressed A string which should be compressed. + */ compress(uncompressed: string): string; /** - * Decompresses "invalid" input string created by the method compress(). - * - * @param compressed A string obtained from a call to compress(). - */ + * Decompresses "invalid" input string created by the method compress(). + * + * @param compressed A string obtained from a call to compress(). + */ decompress(compressed: string): string; /** - * Compresses input string producing an instance of a "valid" UTF-16 string, - * in the sense that all browsers can store them safely. - * - * @param uncompressed A string which should be compressed. - */ + * Compresses input string producing an instance of a "valid" UTF-16 string, + * in the sense that all browsers can store them safely. + * + * @param uncompressed A string which should be compressed. + */ compressToUTF16(uncompressed: string): string; /** - * Decompresses "valid" input string created by the method compressToUTF16(). - * - * @param compressed A string obtained from a call to compressToUTF16(). - */ + * Decompresses "valid" input string created by the method compressToUTF16(). + * + * @param compressed A string obtained from a call to compressToUTF16(). + */ decompressFromUTF16(compressed: string): string; /** - * Compresses input string producing an instance of a ASCII UTF-16 string, - * which represents the original string encoded in Base64. - * The result can be safely transported outside the browser with a - * guarantee that none of the characters produced need to be URL-encoded. - * - * @param uncompressed A string which should be compressed. - */ + * Compresses input string producing an instance of a ASCII UTF-16 string, + * which represents the original string encoded in Base64. + * The result can be safely transported outside the browser with a + * guarantee that none of the characters produced need to be URL-encoded. + * + * @param uncompressed A string which should be compressed. + */ compressToBase64(uncompressed: string): string; /** - * Decompresses ASCII UTF-16 input string created by the method compressToBase64(). - * - * @param compressed A string obtained from a call to compressToBase64(). - */ + * Decompresses ASCII UTF-16 input string created by the method compressToBase64(). + * + * @param compressed A string obtained from a call to compressToBase64(). + */ decompressFromBase64(compressed: string): string; /** - * produces ASCII strings representing the original string encoded in Base64 with a few - * tweaks to make these URI safe. Hence, you can send them to the server without thinking - * about URL encoding them. This saves bandwidth and CPU - * - * @param uncompressed A string which should be compressed. - */ + * produces ASCII strings representing the original string encoded in Base64 with a few + * tweaks to make these URI safe. Hence, you can send them to the server without thinking + * about URL encoding them. This saves bandwidth and CPU + * + * @param uncompressed A string which should be compressed. + */ compressToEncodedURIComponent(uncompressed: string): string; /** - * Decompresses "valid" input string created by the method compressToEncodedURIComponent(). - * - * @param compressed A string obtained from a call to compressToEncodedURIComponent(). - */ + * Decompresses "valid" input string created by the method compressToEncodedURIComponent(). + * + * @param compressed A string obtained from a call to compressToEncodedURIComponent(). + */ decompressFromEncodedURIComponent(compressed: string): string; /** - * produces an uint8Array - * - * @param uncompressed A string which should be compressed. - */ + * produces an uint8Array + * + * @param uncompressed A string which should be compressed. + */ compressToUint8Array(uncompressed: string): Uint8Array; /** - * Decompresses "valid" array created by the method compressToUint8Array(). - * - * @param compressed A string obtained from a call to compressToUint8Array(). - */ + * Decompresses "valid" array created by the method compressToUint8Array(). + * + * @param compressed A string obtained from a call to compressToUint8Array(). + */ decompressFromUint8Array(compressed: Uint8Array): string; } } diff --git a/types/massive/index.d.ts b/types/massive/index.d.ts index 53e857e689..512c9067e2 100644 --- a/types/massive/index.d.ts +++ b/types/massive/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Pascal Birchler // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare namespace massive { +export namespace massive { interface ConnectionOptions { connectionString?: string; db?: string; @@ -11,10 +11,9 @@ declare namespace massive { interface Doc { findDoc(context: any, callback: ResultCallback): void; - searchDoc(options: { - keys: string[]; - term: string; - }, callback: ResultCallback): void; + searchDoc( + options: { keys: string[], term: string }, + callback: ResultCallback): void; saveDoc(context: string, callback: ResultCallback): void; destroy(context: any, callback: ResultCallback): void; } @@ -32,7 +31,7 @@ declare namespace massive { } interface QueryFunction { - find: (params: any|any[], callback: ResultCallback) => void; + find(params: any|any[], callback: ResultCallback): void; } interface QueryArguments { @@ -52,16 +51,16 @@ export interface Massive { practice: Table; practicesession: Table; sport: Table; - testdata: (callback: ResultCallback) => void; + testdata(callback: ResultCallback): void; team: Table; teammember: Table; teamsport: Table; scriptsDir: string; connectionString: string; - query: () => void; - stream: () => void; - executeSqlFile: (args: any, next: ResultCallback) => void; - end: () => void; + query(): void; + stream(): void; + executeSqlFile(args: any, next: ResultCallback): void; + end(): void; tables: Array; views: any[]; queryFiles: massive.QueryFile[]; diff --git a/types/massive/massive-tests.ts b/types/massive/massive-tests.ts index 2978440f4a..cb53e3e7c8 100644 --- a/types/massive/massive-tests.ts +++ b/types/massive/massive-tests.ts @@ -2,4 +2,4 @@ import * as Massive from 'massive'; Massive.connect({connectionString: 'foo'}, (err: Error, db: Massive.Massive) => {}); -Massive.run('foo', 123, (err: Error, db: Massive.Massive) => {}); \ No newline at end of file +Massive.run('foo', 123, (err: Error, db: Massive.Massive) => {}); diff --git a/types/material-ui/index.d.ts b/types/material-ui/index.d.ts index d9ba4fc071..5fd8628598 100644 --- a/types/material-ui/index.d.ts +++ b/types/material-ui/index.d.ts @@ -2,7 +2,7 @@ // Project: https://github.com/callemall/material-ui // Definitions by: Nathan Brown , Oliver Herrmann // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.2 /// /// diff --git a/types/material-ui/material-ui-tests.tsx b/types/material-ui/material-ui-tests.tsx index bb2bba94c8..6e60d6fc0e 100644 --- a/types/material-ui/material-ui-tests.tsx +++ b/types/material-ui/material-ui-tests.tsx @@ -109,7 +109,7 @@ function handleTouchTap() { alert('onTouchTap triggered on the title component'); } -const styles = { +const styles: { [key: string]: React.CSSProperties } = { title: { cursor: 'pointer', }, diff --git a/types/math3d/index.d.ts b/types/math3d/index.d.ts index 5a46c249c9..626aed9df6 100644 --- a/types/math3d/index.d.ts +++ b/types/math3d/index.d.ts @@ -125,7 +125,7 @@ export class Matrix4x4 { size: { rows: number, columns: number }; values: number[]; - determinant(): number + determinant(): number; inverse(): Matrix4x4; negate(): Matrix4x4; transpose(): Matrix4x4; diff --git a/types/mem/index.d.ts b/types/mem/index.d.ts index 0f79a9f525..94ea5137ec 100644 --- a/types/mem/index.d.ts +++ b/types/mem/index.d.ts @@ -5,7 +5,7 @@ interface Options { maxAge?: number; - cacheKey?: (...args: any[]) => string; + cacheKey?(...args: any[]): string; cache?: any; } diff --git a/types/memcached/memcached-tests.ts b/types/memcached/memcached-tests.ts index fc11bd9d27..9101471a8a 100644 --- a/types/memcached/memcached-tests.ts +++ b/types/memcached/memcached-tests.ts @@ -6,32 +6,32 @@ namespace main { if (expected !== undefined && typeof expected !== 'string') { throw new Error(); } - }; + } function isArray(expected?: any[]): void { if (expected !== undefined && !Array.isArray(expected)) { throw new Error(); } - }; + } function isNumber(expected?: number): void { if (expected !== undefined && typeof expected !== 'number') { throw new Error(); } - }; + } function isBoolean(expected?: boolean): void { if (expected !== undefined && typeof expected !== 'boolean') { throw new Error(); } - }; + } function isFunction(expected?: (...args: any[]) => void): void { if (expected !== undefined && typeof expected !== 'function') { throw new Error(); } - }; + } function isVoid(expected?: undefined): void { if (expected !== undefined) { throw new Error(); } - }; + } namespace test_global_options { Memcached.config.maxKeySize = 250; @@ -116,11 +116,11 @@ namespace main { isNumber(expected.totalReconnectsFailed); isNumber(expected.totalDownTime); } - memcached.on('issue', err => isIssue(err)); - memcached.on('failure', err => isIssue(err)); - memcached.on('reconnecting', err => isIssue(err)); - memcached.on('reconnect', err => isIssue(err)); - memcached.on('remove', err => isIssue(err)); + memcached.on('issue', isIssue); + memcached.on('failure', isIssue); + memcached.on('reconnecting', isIssue); + memcached.on('reconnect', isIssue); + memcached.on('remove', isIssue); } function isCommandData(expected: Memcached.CommandData) { @@ -372,7 +372,7 @@ namespace main { isString(stat.server); } }); - }; + } namespace test_settings { memcached.settings((err: any, data: Memcached.StatusData[]) => { isArray(data); @@ -380,7 +380,7 @@ namespace main { isString(setting.server); } }); - }; + } namespace test_slabs { memcached.slabs((err: any, data: Memcached.StatusData[]) => { isArray(data); @@ -388,7 +388,7 @@ namespace main { isString(setting.server); } }); - }; + } let promise: Promise; namespace test_items { promise = new Promise(resolve => { @@ -400,7 +400,7 @@ namespace main { resolve(data); }); }); - }; + } namespace test_cachedump { promise.then(data => { for (const node of data) { @@ -418,12 +418,12 @@ namespace main { }); } }); - }; + } namespace test_flush { memcached.flush(function(err, results) { isVoid(this); isArray(results); }); - }; + } } diff --git a/types/memoizee/index.d.ts b/types/memoizee/index.d.ts index 456641dc59..c83e0ea307 100644 --- a/types/memoizee/index.d.ts +++ b/types/memoizee/index.d.ts @@ -10,10 +10,10 @@ declare namespace memoizee { max?: number; preFetch?: number | true; promise?: boolean; - dispose?: (value: any) => void; + dispose?(value: any): void; async?: boolean; primitive?: boolean; - normalizer?: (value: any) => void; + normalizer?(value: any): void; resolvers?: Array<(arg: any) => any>; } @@ -23,7 +23,7 @@ declare namespace memoizee { } } -// tslint:disable:forbidden-types +// tslint:disable-next-line ban-types declare function memoizee(f: F, options?: memoizee.Options): F & memoizee.Memoized; export = memoizee; diff --git a/types/meteor-collection-hooks/index.d.ts b/types/meteor-collection-hooks/index.d.ts index 8aaf03f91d..73784822ea 100644 --- a/types/meteor-collection-hooks/index.d.ts +++ b/types/meteor-collection-hooks/index.d.ts @@ -72,7 +72,8 @@ declare namespace Mongo { doc: T ) => void ): void; - update(hook: ( + update( + hook: ( userId: string, doc: T, fieldNames: string[], @@ -81,7 +82,8 @@ declare namespace Mongo { ) => void, options?: CollectionHooks.HookOptionValue ): void; - upsert(hook: ( + upsert( + hook: ( userId: string, doc: T, selector: Mongo.Selector, @@ -97,14 +99,14 @@ declare namespace Mongo { limit?: number; fields?: Mongo.FieldSpecifier; reactive?: boolean; - transform?: (doc: any) => void; + transform?(doc: any): void; }): Mongo.Cursor; findOne(selector?: Mongo.Selector | Mongo.ObjectID | string, options?: { sort?: Mongo.SortSpecifier; skip?: number; fields?: Mongo.FieldSpecifier; reactive?: boolean; - transform?: (doc: any) => void; + transform?(doc: any): void; }): T; insert( doc: T, @@ -156,4 +158,4 @@ declare namespace CollectionHooks { after?: LocalHookOptions; all?: LocalHookOptions; } -} \ No newline at end of file +} diff --git a/types/meteor-collection-hooks/meteor-collection-hooks-tests.ts b/types/meteor-collection-hooks/meteor-collection-hooks-tests.ts index b8c0c63247..c3a3c0a7bd 100644 --- a/types/meteor-collection-hooks/meteor-collection-hooks-tests.ts +++ b/types/meteor-collection-hooks/meteor-collection-hooks-tests.ts @@ -76,4 +76,4 @@ Collection.hookOptions = { update: { fetchPrevious: true }, upsert: { fetchPrevious: true } } -}; \ No newline at end of file +}; diff --git a/types/mock-raf/index.d.ts b/types/mock-raf/index.d.ts index bbcbe5e444..9c8ab664bd 100644 --- a/types/mock-raf/index.d.ts +++ b/types/mock-raf/index.d.ts @@ -4,9 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace MockRaf { - interface Options { - /** The time that should pass during each requestAnimationFrame step in milliseconds. Default is roughly equivalent to default browser behavior. */ time?: number; @@ -16,7 +14,6 @@ declare namespace MockRaf { /** Creates a mockRaf instance, exposing the functions you'll use to interact with the mock. */ interface Creator { - /** * Returns the current now value of the mock. Starts at 0 and increases with each step() taken. * Useful for stubbing out performance.now() or a polyfill when using requestAnimationFrame with timers. @@ -32,9 +29,8 @@ declare namespace MockRaf { /** Takes requestAnimationFrame steps. Fires currently queued callbacks for each step and increments now time for each step. The primary way to interact with a mockRaf instance for testing. */ step(options?: Options): void; } - } declare function MockRaf(): MockRaf.Creator; -export = MockRaf; \ No newline at end of file +export = MockRaf; diff --git a/types/mock-raf/mock-raf-tests.ts b/types/mock-raf/mock-raf-tests.ts index 96ba9531d5..d773d1c760 100644 --- a/types/mock-raf/mock-raf-tests.ts +++ b/types/mock-raf/mock-raf-tests.ts @@ -6,4 +6,4 @@ const id = mockRaf.raf(() => { }); mockRaf.step({ count: 10 }); mockRaf.cancel(id); -console.log(mockRaf.now()); \ No newline at end of file +console.log(mockRaf.now()); diff --git a/types/moment-round/moment-round-tests.ts b/types/moment-round/moment-round-tests.ts index 063e3cbea4..4e3829671a 100644 --- a/types/moment-round/moment-round-tests.ts +++ b/types/moment-round/moment-round-tests.ts @@ -1,6 +1,6 @@ import * as moment from 'moment'; -var m = moment(); +const m = moment(); m.round(5, 'seconds'); m.ceil(3, 'minutes'); m.floor(16, 'hours'); diff --git a/types/moment-timezone/moment-timezone-tests.ts b/types/moment-timezone/moment-timezone-tests.ts index 7355142466..9e3e720d24 100644 --- a/types/moment-timezone/moment-timezone-tests.ts +++ b/types/moment-timezone/moment-timezone-tests.ts @@ -10,16 +10,16 @@ const d = moment.tz("May 12th 2014 8PM", "MMM Do YYYY hA", true, "America/Toront a.tz(); -const num = 1367337600000, - arr = [2013, 5, 1], - str = "2013-12-01", - date = new Date(2013, 4, 1), - mo = moment([2013, 4, 1]), - obj = { year : 2013, month : 5, day : 1 }, - format = "YYYY-MM-DD", - formats = ["YYYY-MM-DD", "YYYY/MM/DD"], - formatsIncludingSpecial = ["YYYY-MM-DD", moment.ISO_8601], - language = "en"; +const num = 1367337600000; +const arr = [2013, 5, 1]; +const str = "2013-12-01"; +const date = new Date(2013, 4, 1); +const mo = moment([2013, 4, 1]); +const obj = { year : 2013, month : 5, day : 1 }; +const format = "YYYY-MM-DD"; +const formats = ["YYYY-MM-DD", "YYYY/MM/DD"]; +const formatsIncludingSpecial = ["YYYY-MM-DD", moment.ISO_8601]; +const language = "en"; moment.tz(); moment.tz("America/Los_Angeles"); diff --git a/types/msgpack-lite/index.d.ts b/types/msgpack-lite/index.d.ts index e451267dbc..dfdc3cd821 100644 --- a/types/msgpack-lite/index.d.ts +++ b/types/msgpack-lite/index.d.ts @@ -37,7 +37,7 @@ export function createCodec(options?: CodecOptions): Codec; /** * The default built-in codec */ -export var codec: { +export const codec: { /** * The default built-in codec */ @@ -72,30 +72,30 @@ export interface Encoder { minBufferSize: number; offset: number; start: number; - write: (chunk: any) => void; - fetch: () => void; - flush: () => void; - push: (chunk: any) => void; - pull: () => number; - read: () => number; - reserve: (length: number) => number; - send: (buffer: Buffer) => void; - encode: (chunk: any) => void; - end: (chunk: any) => void; + write(chunk: any): void; + fetch(): void; + flush(): void; + push(chunk: any): void; + pull(): number; + read(): number; + reserve(length: number): number; + send(buffer: Buffer): void; + encode(chunk: any): void; + end(chunk: any): void; } export interface Decoder { bufferish: any; offset: number; - fetch: () => void; - flush: () => void; - pull: () => number; - read: () => number; - write: (chunk: any) => void; - reserve: (length: number) => number; - decode: (chunk: any) => void; - push: (chunk: any) => void; - end: (chunk: any) => void; + fetch(): void; + flush(): void; + pull(): number; + read(): number; + write(chunk: any): void; + reserve(length: number): number; + decode(chunk: any): void; + push(chunk: any): void; + end(chunk: any): void; } export interface EncodeStream extends stream.Transform { @@ -150,4 +150,4 @@ export interface EncoderOptions { export interface DecoderOptions { codec?: Codec; -} \ No newline at end of file +} diff --git a/types/msgpack-lite/msgpack-lite-tests.ts b/types/msgpack-lite/msgpack-lite-tests.ts index a03d86b679..7e357c4b6a 100644 --- a/types/msgpack-lite/msgpack-lite-tests.ts +++ b/types/msgpack-lite/msgpack-lite-tests.ts @@ -3,18 +3,18 @@ import * as msgpack from 'msgpack-lite'; // https://github.com/kawanet/msgpack-lite#encoding-and-decoding-messagepack function encodingAndDecoding() { // encode from JS Object to MessagePack (Buffer) - var buffer = msgpack.encode({foo: "bar"}); + const buffer = msgpack.encode({foo: "bar"}); // decode from MessagePack (Buffer) to JS Object - var data = msgpack.decode(buffer); // => {"foo": "bar"} + const data = msgpack.decode(buffer); // => {"foo": "bar"} } // https://github.com/kawanet/msgpack-lite#writing-to-messagepack-stream function writingToStream() { - var fs = require("fs"); + const fs = require("fs"); - var writeStream = fs.createWriteStream("test.msp"); - var encodeStream = msgpack.createEncodeStream(); + const writeStream = fs.createWriteStream("test.msp"); + const encodeStream = msgpack.createEncodeStream(); encodeStream.pipe(writeStream); // send multiple objects to stream @@ -27,10 +27,10 @@ function writingToStream() { // https://github.com/kawanet/msgpack-lite#reading-from-messagepack-stream function readingFromStream() { - var fs = require("fs"); + const fs = require("fs"); - var readStream = fs.createReadStream("test.msp"); - var decodeStream = msgpack.createDecodeStream(); + const readStream = fs.createReadStream("test.msp"); + const decodeStream = msgpack.createDecodeStream(); // show multiple objects decoded from stream readStream.pipe(decodeStream).on("data", console.warn); @@ -50,25 +50,25 @@ function decodingBytesArray() { // https://github.com/kawanet/msgpack-lite#custom-extension-types-codecs function customExtensionTypes() { - var codec = msgpack.createCodec(); - codec.addExtPacker(0x3F, MyVector, myVectorPacker); - codec.addExtUnpacker(0x3F, myVectorUnpacker); - - var data = new MyVector(1, 2); - var encoded = msgpack.encode(data, {codec}); - var decoded = msgpack.decode(encoded, {codec}); - class MyVector { constructor(public x: number, public y: number) {} } + const codec = msgpack.createCodec(); + codec.addExtPacker(0x3F, MyVector, myVectorPacker); + codec.addExtUnpacker(0x3F, myVectorUnpacker); + + const data = new MyVector(1, 2); + const encoded = msgpack.encode(data, {codec}); + const decoded = msgpack.decode(encoded, {codec}); + function myVectorPacker(vector: MyVector) { - var array = [vector.x, vector.y]; + const array = [vector.x, vector.y]; return msgpack.encode(array); // return Buffer serialized } function myVectorUnpacker(buffer: Buffer | Uint8Array): MyVector { - var array = msgpack.decode(buffer); + const array = msgpack.decode(buffer); return new MyVector(array[0], array[1]); // return Object deserialized } } diff --git a/types/multimatch/index.d.ts b/types/multimatch/index.d.ts index 7130cafbd0..3eeecc3791 100644 --- a/types/multimatch/index.d.ts +++ b/types/multimatch/index.d.ts @@ -14,7 +14,6 @@ declare function multimatch(paths: string[], patterns: string | string[], options?: multimatch.MultimatchOptions): string[]; declare namespace multimatch { - /** * Options based on [minimatch](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) */ @@ -67,7 +66,6 @@ declare namespace multimatch { */ flipNegate?: boolean; } - } export = multimatch; diff --git a/types/nanoscroller/index.d.ts b/types/nanoscroller/index.d.ts index ede65fc283..ffa648b1ab 100644 --- a/types/nanoscroller/index.d.ts +++ b/types/nanoscroller/index.d.ts @@ -8,115 +8,115 @@ declare namespace JQueryNanoScroller { interface NanoScrollerOptions { /** - * To scroll at the top or bottom. - */ + * To scroll at the top or bottom. + */ scroll?: 'top' | 'bottom'; /** - * To scroll at the top with an offset value. - */ + * To scroll at the top with an offset value. + */ scrollTop?: number; /** - * To scroll at the bottom with an offset value. - */ + * To scroll at the bottom with an offset value. + */ scrollBottom?: number; /** - * To scroll to an element. - */ + * To scroll to an element. + */ scrollTo?: JQuery; /** - * To stop the operation. - * This option will tell the plugin to disable all event bindings and hide the gadget scrollbar from the UI. - */ + * To stop the operation. + * This option will tell the plugin to disable all event bindings and hide the gadget scrollbar from the UI. + */ stop?: boolean; /** - * Destroys nanoScroller and restores browser's native scrollbar. - */ + * Destroys nanoScroller and restores browser's native scrollbar. + */ destroy?: boolean; /** - * To flash the scrollbar gadget for an amount of time defined in plugin settings (defaults to 1,5s). - * Useful if you want to show the user that there is more content waiting for him. - */ + * To flash the scrollbar gadget for an amount of time defined in plugin settings (defaults to 1,5s). + * Useful if you want to show the user that there is more content waiting for him. + */ flash?: boolean; /** - * Set to true if you want to use native scrolling in iOS 5+. - * This will disable your custom nanoScroller scrollbar in iOS 5+ and use the native one instead. - * While the native iOS scrollbar usually works much better, there could possibly be bugs in certain situations. - * @default false - */ + * Set to true if you want to use native scrolling in iOS 5+. + * This will disable your custom nanoScroller scrollbar in iOS 5+ and use the native one instead. + * While the native iOS scrollbar usually works much better, there could possibly be bugs in certain situations. + * @default false + */ iOSNativeScrolling?: boolean; /** - * Sets the minimum height of the slider element. - * @default 20 - */ + * Sets the minimum height of the slider element. + * @default 20 + */ sliderMinHeight?: number; /** - * Sets the maximum height of the slider element. - * @default null - */ + * Sets the maximum height of the slider element. + * @default null + */ sliderMaxHeight?: number | null; /** - * Set to true to prevent page scrolling when top or bottom inside the content div is reached. - * @default false - */ + * Set to true to prevent page scrolling when top or bottom inside the content div is reached. + * @default false + */ preventPageScrolling?: boolean; /** - * Set to true to disable the resize from nanoscroller. - * Useful if you want total control of the resize event. - * If you set this option to true remember to call the reset method so that the scroll don't have strange behavior. - * @default false - */ + * Set to true to disable the resize from nanoscroller. + * Useful if you want total control of the resize event. + * If you set this option to true remember to call the reset method so that the scroll don't have strange behavior. + * @default false + */ disableResize?: boolean; /** - * Set to true to stop the scrollbar from auto-hiding itself. - * @default false - */ + * Set to true to stop the scrollbar from auto-hiding itself. + * @default false + */ alwaysVisible?: boolean; /** - * Use this setting to specify the scrollbar hide delay in milliseconds if you have enabled the flash option. - * @default 1500 - */ + * Use this setting to specify the scrollbar hide delay in milliseconds if you have enabled the flash option. + * @default 1500 + */ flashDelay?: number; /** - * A classname for scrollbar track element. - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'nano-pane' - */ + * A classname for scrollbar track element. + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'nano-pane' + */ paneClass?: string; /** - * A classname for scrollbar thumb element. - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'nano-slider' - */ + * A classname for scrollbar thumb element. + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'nano-slider' + */ sliderClass?: string; /** - * A classname for your content div. - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'nano-content' - */ + * A classname for your content div. + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'nano-content' + */ contentClass?: string; /** - * A classname for scrollbar enabled mode. - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'has-scrollbar' - */ + * A classname for scrollbar enabled mode. + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'has-scrollbar' + */ enabledClass?: string; /** - * A classname for scrollbar flashed mode. - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'flashed' - */ + * A classname for scrollbar flashed mode. + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'flashed' + */ flashedClass?: string; /** - * - * If you change this setting, you also have to change it in the plugin's CSS file. - * @default 'active' - */ + * + * If you change this setting, you also have to change it in the plugin's CSS file. + * @default 'active' + */ activeClass?: string; /** - * Set the tab order of the scrollable content. - * Set to -1 to skip over the scrollable content when tabbing. - * @default 0 - */ + * Set the tab order of the scrollable content. + * Set to -1 to skip over the scrollable content when tabbing. + * @default 0 + */ tabIndex?: number; } } diff --git a/types/navigation-react/index.d.ts b/types/navigation-react/index.d.ts index 32ee6570f3..106b14bf43 100644 --- a/types/navigation-react/index.d.ts +++ b/types/navigation-react/index.d.ts @@ -22,7 +22,7 @@ interface LinkProps extends HTMLProps { /** * Handles Link click events */ - navigating?: (e: MouseEvent, domId: string, link: string) => boolean; + navigating?(e: MouseEvent, domId: string, link: string): boolean; /** * The State Navigator */ diff --git a/types/navigo/index.d.ts b/types/navigo/index.d.ts index 35c9f009f6..138d0c043f 100644 --- a/types/navigo/index.d.ts +++ b/types/navigo/index.d.ts @@ -4,13 +4,12 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface NavigoHooks { - before?: ((done: (suppress?: boolean) => void) => void); - after?: () => void; + before?(done: (suppress?: boolean) => void): void; + after?(): void; } -type RouteHandler = ((parametersObj: any, query: string) => void) | { as: string; uses: (parametersObj: any) => void }; +type RouteHandler = ((parametersObj: any, query: string) => void) | { as: string; uses(parametersObj: any): void }; declare class Navigo { - /** * Constructs the router * @param root The main URL of your application. @@ -18,7 +17,6 @@ declare class Navigo { */ constructor(root?: string | null, useHash?: boolean); - on(location: string, handler: RouteHandler, hooks?: NavigoHooks): Navigo; on(location: RegExp, handler: (...parameters: string[]) => void, hooks?: NavigoHooks): Navigo; on(routes: { [key: string]: RouteHandler }): Navigo; @@ -46,4 +44,4 @@ declare class Navigo { destroy(): void; } export = Navigo; -export as namespace Navigo; \ No newline at end of file +export as namespace Navigo; diff --git a/types/navigo/navigo-tests.ts b/types/navigo/navigo-tests.ts index 73ea91f416..762c97b6de 100644 --- a/types/navigo/navigo-tests.ts +++ b/types/navigo/navigo-tests.ts @@ -1,9 +1,9 @@ import Navigo = require("navigo"); -var root = null; -var useHash = false; +const root = null; +const useHash = false; -var router = new Navigo(root, useHash); +let router = new Navigo(root, useHash); router .on('/products/list', () => { @@ -33,7 +33,7 @@ router 'products/:id': () => { // do something }, - 'products': () => { + products: () => { // do something }, '*': () => { @@ -42,7 +42,6 @@ router }) .resolve(); - router .on('/user/:id/:action', (params: { id: string; action: string }) => { // If we have http://site.com/user/42/save as a url then @@ -89,7 +88,7 @@ router.navigate('/products/list'); router.navigate('http://site.com/products/list', true); router = new Navigo('http://site.com/', true); -var handler = () => { +const handler = () => { // do something }; router.on({ @@ -97,7 +96,7 @@ router.on({ '/trip/save': { as: 'trip.save', uses: handler }, '/trip/:action/:tripId': { as: 'trip.action', uses: handler } }); -var a: string = (router.generate('trip.edit', { tripId: 42 })); // --> /trip/42/edit +let a: string = (router.generate('trip.edit', { tripId: 42 })); // --> /trip/42/edit a = (router.generate('trip.action', { tripId: 42, action: 'save' })); // --> /trip/save/42 a = (router.generate('trip.save')); // --> /trip/save diff --git a/types/nedb/index.d.ts b/types/nedb/index.d.ts index ea5a9e8d4e..d85016493e 100644 --- a/types/nedb/index.d.ts +++ b/types/nedb/index.d.ts @@ -181,11 +181,11 @@ declare namespace Nedb { nodeWebkitAppName?: boolean; // Optional, specify the name of your NW app if you want options.filename to be relative to the directory where autoload?: boolean; // Optional, defaults to false // Optional, if autoload is used this will be called after the load database with the error object as parameter. If you don't pass it the error will be thrown - onload?: (error: Error) => any; + onload?(error: Error): any; // (optional): hook you can use to transform data after it was serialized and before it is written to disk. // Can be used for example to encrypt data before writing database to disk. // This function takes a string as parameter (one line of an NeDB data file) and outputs the transformed string, which must absolutely not contain a \n character (or data will be lost) - afterSerialization?: (line: string) => string; + afterSerialization?(line: string): string; // (optional): reverse of afterSerialization. // Make sure to include both and not just one or you risk data loss. // For the same reason, make sure both functions are inverses of one another. @@ -193,7 +193,7 @@ declare namespace Nedb { // NeDB checks that never one is declared without the other, and checks that they are reverse of one another by testing on random strings of various lengths. // In addition, if too much data is detected as corrupt, // NeDB will refuse to start as it could mean you're not using the deserialization hook corresponding to the serialization hook used before (see below) - beforeDeserialization?: (line: string) => string; + beforeDeserialization?(line: string): string; // (optional): between 0 and 1, defaults to 10%. NeDB will refuse to start if more than this percentage of the datafile is corrupt. // 0 means you don't tolerate any corruption, 1 means you don't care corruptAlertThreshold?: number; diff --git a/types/node-hid/node-hid-tests.ts b/types/node-hid/node-hid-tests.ts index ef1f0c7e03..27d0f1f45d 100644 --- a/types/node-hid/node-hid-tests.ts +++ b/types/node-hid/node-hid-tests.ts @@ -1,13 +1,12 @@ import HID = require('node-hid'); -var devices = HID.devices(); +const devices = HID.devices(); +let device = new HID.HID("path"); -var device = new HID.HID("path"); - -var device = new HID.HID(12, 22); +device = new HID.HID(12, 22); device.on("data", data => {}); device.on("error", err => {}); -device.write([0x00, 0x01, 0x01, 0x05, 0xff, 0xff]); \ No newline at end of file +device.write([0x00, 0x01, 0x01, 0x05, 0xff, 0xff]); diff --git a/types/node-xmpp-client/index.d.ts b/types/node-xmpp-client/index.d.ts index 1747740be7..02f8a64e59 100644 --- a/types/node-xmpp-client/index.d.ts +++ b/types/node-xmpp-client/index.d.ts @@ -67,5 +67,5 @@ interface XmppOptions { interface Bosh { url?: string; - prebind?: (error: any, data: any) => void; + prebind?(error: any, data: any): void; } diff --git a/types/node-xmpp-core/index.d.ts b/types/node-xmpp-core/index.d.ts index 68d985b666..8c552c08f2 100644 --- a/types/node-xmpp-core/index.d.ts +++ b/types/node-xmpp-core/index.d.ts @@ -66,17 +66,17 @@ export class JID { /** * Convenience method to distinguish users - **/ + */ bare(): JID; /** * Comparison function - **/ + */ equals(other: JID): boolean; /** * http://xmpp.org/rfcs/rfc6122.html#addressing-localpart - **/ + */ setLocal(local: string, escape?: any): void; getLocal(unescape?: any): string; diff --git a/types/ns-api/ns-api-tests.ts b/types/ns-api/ns-api-tests.ts index 129e54d6b9..5063a97e48 100644 --- a/types/ns-api/ns-api-tests.ts +++ b/types/ns-api/ns-api-tests.ts @@ -55,4 +55,4 @@ ns.storingen({}, (err, data) => { } else { console.log(data); } -}); \ No newline at end of file +}); diff --git a/types/oauth2orize/index.d.ts b/types/oauth2orize/index.d.ts index 2c4b0a7601..a8fbf9c41b 100644 --- a/types/oauth2orize/index.d.ts +++ b/types/oauth2orize/index.d.ts @@ -1,46 +1,143 @@ -// Type definitions for oauth2orize v1.5.1 +// Type definitions for oauth2orize 1.8 // Project: https://github.com/jaredhanson/oauth2orize/ -// Definitions by: Wonshik Kim , Kei Son -// Definitions: https://github.com/borisyankov/DefinitelyTyped +// Definitions by: Wonshik Kim , Kei Son , Steve Hipwell +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// +/// -import * as http from "http"; +import { ServerRequest, ServerResponse } from "http"; -interface ServerOptions { +interface OAuth2 { + client: any; + + user: any; + + transactionID: string; + + redirectURI: string; + + req: OAuth2Req; + + info: OAuth2Info; +} + +interface OAuth2Req { + clientID: string; + + redirectURI: string; + + scope: string; + + state: string; + + type: string; + + transactionID: string; +} + +interface OAuth2Info { + scope: string; +} + +export interface MiddlewareRequest extends ServerRequest { + oauth2?: OAuth2; + + user?: any; +} + +export interface ServerOptions { store: any; loadTransaction: boolean; } -export function createServer(options?: ServerOptions): OAuth2Server; + +export const createServer: (options?: ServerOptions) => OAuth2Server; export interface AuthorizeOptions { idLength?: number; sessionKey?: string; } +export interface DecisionOptions { + cancelField: string; + userProperty: string; + sessionKey: string; +} + export interface ErrorHandlerOptions { mode?: string; } -type MiddlewareFunction = (req: http.IncomingMessage, res: http.ServerResponse, next: Function) => void; -type ValidatedFunction = (err: Error | null, client?: any, redirectURI?: string) => void; -type IssuedFunction = (err: Error | null, accessToken?: string | boolean, refreshToken?: string, params?: any) => void; +type MiddlewareFunction = (req: MiddlewareRequest, res: ServerResponse, next: MiddlewareNextFunction) => void; + +type MiddlewareErrorFunction = (err: Error, req: MiddlewareRequest, res: ServerResponse, next: MiddlewareNextFunction) => void; + +type MiddlewareNextFunction = (err?: Error) => void; + +type ValidateFunction = (clientId: string, redirectURI: string, validated: (err: Error | null, client?: any, redirectURI?: string) => void) => void; + +type ImmediateFunction = (client: any, user: any, scope: string[], type: string, areq: any, done: (err: Error | null, allow: boolean, info: any, locals: any) => void) => void; + +type DecisionParseFunction = (req: MiddlewareRequest, done: (err: Error | null, params: any) => void) => void; + +type SerializeClientFunction = (client: any, done: SerializeClientDoneFunction) => void; +type SerializeClientDoneFunction = (err: Error | null, id: string) => void; + +type DeserializeClientFunction = (id: string, done: DeserializeClientDoneFunction) => void; +type DeserializeClientDoneFunction = (err: Error | null, client?: any | boolean) => void; + +type IssueGrantCodeFunction = (client: any, redirectUri: string, user: any, res: any, issued: (err: Error | null, code?: string) => void) => void; + +type IssueGrantTokenFunction = (client: any, user: any, ares: any, issued: (err: Error | null, code?: string, params?: any) => void) => void; + + +type IssueExchangeCodeFunction = (client: any, code: string, redirectURI: string, issued: ExchangeDoneFunction) => void; + +type ExchangeDoneFunction = (err: Error | null, accessToken?: string | boolean, refreshToken?: string, params?: any) => void; + export class OAuth2Server { - exchange(fn: MiddlewareFunction): OAuth2Server; + grant(type: string, fn: MiddlewareFunction): OAuth2Server; + grant(fn: MiddlewareFunction): OAuth2Server; + exchange(type: string, fn: MiddlewareFunction): OAuth2Server; - // Parses requests to obtain authorization - authorize (options: AuthorizeOptions, validate: (clientId: string, redirectURI: string, validated: ValidatedFunction) => void): MiddlewareFunction; - authorization(options: AuthorizeOptions, validate: (clientId: string, redirectURI: string, validated: ValidatedFunction) => void): MiddlewareFunction; - authorize (validate: (clientId: string, redirectURI: string, validated: ValidatedFunction) => void): MiddlewareFunction; - authorization(validate: (clientId: string, redirectURI: string, validated: ValidatedFunction) => void): MiddlewareFunction; + exchange(fn: MiddlewareFunction): OAuth2Server; + + authorize(options: AuthorizeOptions, validate: ValidateFunction): MiddlewareFunction; + authorize(validate: ValidateFunction): MiddlewareFunction; + + authorization(options: AuthorizeOptions, validate: ValidateFunction, immediate?: ImmediateFunction): MiddlewareFunction; + authorization(validate: ValidateFunction, immediate?: ImmediateFunction): MiddlewareFunction; + + decision(options: DecisionOptions, parse: DecisionParseFunction): MiddlewareFunction; + decision(parse: DecisionParseFunction): MiddlewareFunction; token(options?: any): MiddlewareFunction; - errorHandler(options?: any): (err: Error, req: http.IncomingMessage, res: http.ServerResponse, next: any) => void; - serializeClient(fn: (client: any, done: (err: Error | null, id: string) => void) => void): void; - serializeClient(client: any, done: (err: Error | null, id: string) => void): void; - deserializeClient(fn: (id: string, done: (err: Error | null, client?: any | boolean) => void) => void): void; - deserializeClient(obj: any, done: (err: Error | null, client?: any | boolean) => void): void; + + errorHandler(options?: any): MiddlewareErrorFunction; + + serializeClient(fn: SerializeClientFunction): void; + serializeClient(client: any, done: SerializeClientDoneFunction): void; + + deserializeClient(fn: DeserializeClientFunction): void; + deserializeClient(obj: any, done: DeserializeClientDoneFunction): void; +} + +export namespace grant { + interface Options { + // For maximum flexibility, multiple scope spearators can optionally be + // allowed. This allows the server to accept clients that separate scope + // with either space or comma (' ', ','). This violates the specification, + // but achieves compatibility with existing client libraries that are already + // deployed. + scopeSeparator?: string; + } + + function code(options: Options, issue: IssueGrantCodeFunction): MiddlewareFunction; + function code(issue: IssueGrantCodeFunction): MiddlewareFunction; + + function token(options: Options, issue: IssueGrantTokenFunction): MiddlewareFunction; + function token(issue: IssueGrantTokenFunction): MiddlewareFunction; } export namespace exchange { @@ -57,41 +154,42 @@ export namespace exchange { scopeSeparator?: string; } - function authorizationCode(options: Options, issue: (client: any, code: string, redirectURI: string, issued: IssuedFunction) => void): MiddlewareFunction; - function authorizationCode(issue: (client: any, code: string, redirectURI: string, issued: IssuedFunction) => void): MiddlewareFunction; - function code(options: Options, issue: (client: any, code: string, redirectURI: string, issued: IssuedFunction) => void): MiddlewareFunction; - function code(issue: (client: any, code: string, redirectURI: string, issued: IssuedFunction) => void): MiddlewareFunction; + function authorizationCode(options: Options, issue: IssueExchangeCodeFunction): MiddlewareFunction; + function authorizationCode(issue: IssueExchangeCodeFunction): MiddlewareFunction; + + function code(options: Options, issue: IssueExchangeCodeFunction): MiddlewareFunction; + function code(issue: IssueExchangeCodeFunction): MiddlewareFunction; // arity == 5; issue(client, scope, req.body, req.authInfo, issued); - function clientCredentials(options: Options, issue: (client: any, scope: string[], body: any, authInfo: any, issued: IssuedFunction) => void): MiddlewareFunction; + function clientCredentials(options: Options, issue: (client: any, scope: string[], body: any, authInfo: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 4; issue(client, scope, req.body, issued); - function clientCredentials(options: Options, issue: (client: any, scope: string[], body: any, issued: IssuedFunction) => void): MiddlewareFunction; + function clientCredentials(options: Options, issue: (client: any, scope: string[], body: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 3; issue(client, scope, issued); - function clientCredentials(options: Options, issue: (client: any, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; + function clientCredentials(options: Options, issue: (client: any, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 2; issue(client, issued); - function clientCredentials(options: Options, issue: (client: any, issued: IssuedFunction) => void): MiddlewareFunction; - function clientCredentials(issue: (client: any, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; - function clientCredentials(issue: (client: any, issued: IssuedFunction) => void): MiddlewareFunction; + function clientCredentials(options: Options, issue: (client: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function clientCredentials(issue: (client: any, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function clientCredentials(issue: (client: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 7; issue(client, username, passwd, scope, req.body, req.authInfo, issued); - function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], body: any, authInfo: any, issued: IssuedFunction) => void): MiddlewareFunction; + function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], body: any, authInfo: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 6; issue(client, username, passwd, scope, req.body, issued); - function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], body: any, issued: IssuedFunction) => void): MiddlewareFunction; + function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], body: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 5; issue(client, username, passwd, scope, issued); - function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; + function password(options: Options, issue: (client: any, username: string, password: string, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 4; issue(client, username, passwd, issued); - function password(options: Options, issue: (client: any, username: string, password: string, issued: IssuedFunction) => void): MiddlewareFunction; - function password(issue: (client: any, username: string, password: string, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; - function password(issue: (client: any, username: string, password: string, issued: IssuedFunction) => void): MiddlewareFunction; + function password(options: Options, issue: (client: any, username: string, password: string, issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function password(issue: (client: any, username: string, password: string, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function password(issue: (client: any, username: string, password: string, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 6; issue(client, refreshToken, scope, req.body, req.authInfo, issued); - function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], body: any, authInfo: any, issued: IssuedFunction) => void): MiddlewareFunction; + function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], body: any, authInfo: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 5; issue(client, refreshToken, scope, req.body, issued); - function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], body: any, issued: IssuedFunction) => void): MiddlewareFunction; + function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], body: any, issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 4; issue(client, refreshToken, scope, issued); - function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; + function refreshToken(options: Options, issue: (client: any, refreshToken: string, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; // arity == 3; issue(client, refreshToken, issued); - function refreshToken(options: Options, issue: (client: any, refreshToken: string, issued: IssuedFunction) => void): MiddlewareFunction; - function refreshToken(issue: (client: any, refreshToken: string, scope: string[], issued: IssuedFunction) => void): MiddlewareFunction; - function refreshToken(issue: (client: any, refreshToken: string, issued: IssuedFunction) => void): MiddlewareFunction; + function refreshToken(options: Options, issue: (client: any, refreshToken: string, issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function refreshToken(issue: (client: any, refreshToken: string, scope: string[], issued: ExchangeDoneFunction) => void): MiddlewareFunction; + function refreshToken(issue: (client: any, refreshToken: string, issued: ExchangeDoneFunction) => void): MiddlewareFunction; } diff --git a/types/oauth2orize/oauth2orize-tests.ts b/types/oauth2orize/oauth2orize-tests.ts index 9795b3e89e..49d7c94794 100644 --- a/types/oauth2orize/oauth2orize-tests.ts +++ b/types/oauth2orize/oauth2orize-tests.ts @@ -7,15 +7,15 @@ import * as http from 'http'; const server = oauth2orize.createServer(); // Register Grants -// server.grant(oauth2orize.grant.code(function(client, redirectURI, user, ares, done) { -// var code = utils.uid(16); +server.grant(oauth2orize.grant.code((client, redirectURI, user, ares, done) => { + // var code = utils.uid(16); -// var ac = new AuthorizationCode(code, client.id, redirectURI, user.id, ares.scope); -// ac.save(function(err) { -// if (err) { return done(err); } -// return done(null, code); -// }); -// })); + // var ac = new AuthorizationCode(code, client.id, redirectURI, user.id, ares.scope); + // ac.save(function(err) { + // if (err) { return done(err); } + // return done(null, code); + // }); +})); // Register Exchanges @@ -25,8 +25,8 @@ class AuthorizationCode { }) => void): void {} } -server.exchange(oauth2orize.exchange.code(function(client, code, redirectURI, done) { - AuthorizationCode.findOne(code, function(err, code) { +server.exchange(oauth2orize.exchange.code((client, code, redirectURI, done) => { + AuthorizationCode.findOne(code, (err, code) => { if (err) { return done(err); } if (client.id !== code.clientId) { return done(null, false); } if (redirectURI !== code.redirectURI) { return done(null, false); } @@ -50,27 +50,27 @@ class Clients { // app.get('/dialog/authorize', // login.ensureLoggedIn(), - server.authorize(function(clientID, redirectURI, done) { - Clients.findOne(clientID, function(err, client) { + server.authorize((clientID, redirectURI, done) => { + Clients.findOne(clientID, (err, client) => { if (err) { return done(err); } if (!client) { return done(null, false); } if (client.redirectURI != redirectURI) { return done(null, false); } return done(null, client, client.redirectURI); }); }), - function(req: http.IncomingMessage, res: http.ServerResponse) { + (req: http.IncomingMessage, res: http.ServerResponse) => { // res.render('dialog', { transactionID: req.oauth2.transactionID, // user: req.user, client: req.oauth2.client }); } // ); // Session Serialization -server.serializeClient(function(client, done) { +server.serializeClient((client, done) => { return done(null, client.id); }); -server.deserializeClient(function(id, done) { - Clients.findOne(id, function(err, client) { +server.deserializeClient((id, done) => { + Clients.findOne(id, (err, client) => { if (err) { return done(err); } return done(null, client); }); diff --git a/types/opener/opener-tests.ts b/types/opener/opener-tests.ts index 477fe4b3f8..7f69d8f2dd 100644 --- a/types/opener/opener-tests.ts +++ b/types/opener/opener-tests.ts @@ -7,5 +7,5 @@ opener('./my-file.txt'); opener('firefox'); opener('npm run lint'); -var editor = opener('documentation.odt'); +const editor = opener('documentation.odt'); editor.unref(); diff --git a/types/openfin/index.d.ts b/types/openfin/index.d.ts index e6c11d0180..ac90c223f7 100644 --- a/types/openfin/index.d.ts +++ b/types/openfin/index.d.ts @@ -19,7 +19,7 @@ * Overview * When running within the OpenFin Runtime your web applications have access to the "fin" namespace and all the modules within the API * without the need to include additional source files. You can treat the "fin" namespace as you would the "window", "navigator" or "document" objects. - **/ + */ declare namespace fin { const desktop: OpenFinDesktop; @@ -38,7 +38,9 @@ declare namespace fin { * Creates a new Application. * An object representing an application. Allows the developer to create, execute, show/close an application as well as listen to application events. */ - new (options: ApplicationOptions, callback?: (successObj: { httpResponseCode: number }) => void, + new ( + options: ApplicationOptions, + callback?: (successObj: { httpResponseCode: number }) => void, errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): OpenFinApplication; /** * Returns an Application object that represents an existing application. @@ -62,7 +64,8 @@ declare namespace fin { /** * Registers an event listener on the specified event. */ - addEventListener(type: OpenFinApplicationEventType, + addEventListener( + type: OpenFinApplicationEventType, listener: (event: ApplicationBaseEvent | TrayIconClickedEvent | WindowEvent @@ -70,7 +73,8 @@ declare namespace fin { | WindowAuthRequested | WindowNavigationRejectedEvent | WindowEndLoadEvent) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; + callback?: () => void, + errorCallback?: (reason: string) => void): void; /** * Closes the application and any child windows created by the application. */ @@ -110,7 +114,8 @@ declare namespace fin { /** * Removes a previously registered event listener from the specified event. */ - removeEventListener(type: OpenFinApplicationEventType, + removeEventListener( + type: OpenFinApplicationEventType, previouslyRegisteredListener: (event: ApplicationBaseEvent | TrayIconClickedEvent | WindowEvent @@ -118,7 +123,8 @@ declare namespace fin { | WindowAuthRequested | WindowNavigationRejectedEvent | WindowEndLoadEvent) => any, - callback?: () => void, errorCallback?: (reason: string) => void): void; + callback?: () => void, + errorCallback?: (reason: string) => void): void; /** * Removes the application's icon from the tray. */ @@ -423,12 +429,18 @@ declare namespace fin { /** * Registers an event listener on the specified event. */ - addEventListener(type: OpenFinExternalApplicationEventType, listener: () => void, callback?: () => void, + addEventListener( + type: OpenFinExternalApplicationEventType, + listener: () => void, + callback?: () => void, errorCallback?: (reason: string, error: ErrorInfo) => void): void; /** * Removes a previously registered event listener from the specified event. */ - removeEventListener(type: OpenFinExternalApplicationEventType, listener: () => void, callback?: () => void, + removeEventListener( + type: OpenFinExternalApplicationEventType, + listener: () => void, + callback?: () => void, errorCallback?: (reason: string, error: ErrorInfo) => void): void; } @@ -466,17 +478,35 @@ declare namespace fin { * Subscribes to messages from the specified application on the specified topic. If the subscription is for a uuid, [name], * topic combination that has already been published to upon subscription you will receive the last 20 missed messages in the order they were published. */ - subscribe(senderUuid: string, name: string, topic: string, listener: (message: any, uuid: string, name: string) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; - subscribe(senderUuid: string, topic: string, listener: (message: any, uuid: string, name: string) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; + subscribe( + senderUuid: string, + name: string, + topic: string, + listener: (message: any, uuid: string, name: string) => void, + callback?: () => void, + errorCallback?: (reason: string) => void): void; + subscribe( + senderUuid: string, + topic: string, + listener: (message: any, uuid: string, name: string) => void, + callback?: () => void, + errorCallback?: (reason: string) => void): void; /** * Unsubscribes to messages from the specified application on the specified topic. */ - unsubscribe(senderUuid: string, name: string, topic: string, listener: (message: any, uuid: string, name: string) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; - unsubscribe(senderUuid: string, topic: string, listener: (message: any, uuid: string, name: string) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; + unsubscribe( + senderUuid: string, + name: string, + topic: string, + listener: (message: any, uuid: string, name: string) => void, + callback?: () => void, + errorCallback?: (reason: string) => void): void; + unsubscribe( + senderUuid: string, + topic: string, + listener: (message: any, uuid: string, name: string) => void, + callback?: () => void, + errorCallback?: (reason: string) => void): void; } interface OpenFinNotificationStatic { @@ -570,9 +600,11 @@ declare namespace fin { /** * Registers an event listener on the specified event. */ - addEventListener(type: OpenFinSystemEventType, + addEventListener( + type: OpenFinSystemEventType, listener: (event: SystemBaseEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; + callback?: () => void, + errorCallback?: (reason: string) => void): void; /** * Clears cached data containing window state/positions, * application resource files (images, HTML, JavaScript files), cookies, and items stored in the Local Storage. @@ -585,8 +617,11 @@ declare namespace fin { /** * Downloads the given application asset */ - downloadAsset(assetObj: AppAssetInfo, progressListener?: (progress: { downloadedBytes: number, totalBytes: number }) => void, - callback?: (successObj: { path: string }) => void, errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): void; + downloadAsset( + assetObj: AppAssetInfo, + progressListener?: (progress: { downloadedBytes: number, totalBytes: number }) => void, + callback?: (successObj: { path: string }) => void, + errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): void; /** * Exits the Runtime. */ @@ -671,16 +706,19 @@ declare namespace fin { /** * This function call will register a unique id and produce a token. The token can be used to broker an external connection. */ - registerExternalConnection(uuid: string, callback?: (detail: { - /** - * this will be unique each time - */ - token: string; - /** - * "remote-connection-uuid" - */ - uuid: string; - }) => void, errorCallback?: (reason: string) => void): void; + registerExternalConnection( + uuid: string, + callback?: (detail: { + /** + * this will be unique each time + */ + token: string; + /** + * "remote-connection-uuid" + */ + uuid: string; + }) => void, + errorCallback?: (reason: string) => void): void; /** * Removes the process entry for the passed UUID obtained from a prior call of fin.desktop.System.launchExternalProcess(). */ @@ -688,7 +726,8 @@ declare namespace fin { /** * Removes a previously registered event listener from the specified event. */ - removeEventListener(type: OpenFinSystemEventType, + removeEventListener( + type: OpenFinSystemEventType, listener: (event: SystemBaseEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent) => void, callback?: () => void, errorCallback?: (reason: string) => void): void; /** @@ -698,9 +737,16 @@ declare namespace fin { /** * Attempt to close an external process. The process will be terminated if it has not closed after the elapsed timeout in milliseconds. */ - terminateExternalProcess(processUuid: string, timeout: number, killTree: boolean, callback?: (info: { result: "clean" | "terminated" | "failed" }) => void, + terminateExternalProcess( + processUuid: string, + timeout: number, + killTree: boolean, + callback?: (info: { result: "clean" | "terminated" | "failed" }) => void, errorCallback?: (reason: string) => void): void; - terminateExternalProcess(processUuid: string, timeout: number, callback?: (info: { result: "clean" | "terminated" | "failed" }) => void, + terminateExternalProcess( + processUuid: string, + timeout: number, + callback?: (info: { result: "clean" | "terminated" | "failed" }) => void, errorCallback?: (reason: string) => void): void; /** * Update the OpenFin Runtime Proxy settings. @@ -932,7 +978,7 @@ declare namespace fin { * over any 'args' set in the 'app.json'. */ arguments?: string; - listener?: (result: { + listener?(result: { /** * "Exited" Or "released" on a call to releaseExternalProcess */ @@ -945,7 +991,7 @@ declare namespace fin { * Process exit code */ exitCode?: number; - }) => void; + }): void; certificate?: CertificationInfo; } @@ -974,7 +1020,7 @@ declare namespace fin { interface ExternalProcessInfo { pid?: number; - listener?: (result: { + listener?(result: { /** * "Exited" Or "released" on a call to releaseExternalProcess */ @@ -984,10 +1030,10 @@ declare namespace fin { */ uuid?: string; /* - * Process exit code - */ + * Process exit code + */ exitCode?: number; - }) => void; + }): void; } interface OpenFinWindowStatic { @@ -1005,7 +1051,9 @@ declare namespace fin { * @param {Function} [callback] - Called if the window creation was successful * @param {number} [callback.successObj] - httpResponseCode */ - new (options: WindowOptions, callback?: (successObj: { httpResponseCode: number }) => void, + new ( + options: WindowOptions, + callback?: (successObj: { httpResponseCode: number }) => void, errorCallback?: (reason: string, errorObj: NetworkErrorInfo) => void): OpenFinWindow; /** * Returns an instance of the current window. @@ -1049,14 +1097,16 @@ declare namespace fin { /** * Registers an event listener on the specified event. */ - addEventListener(type: OpenFinWindowEventType, listener: (event: WindowBaseEvent - | WindowAuthRequestedEvent - | WindowBoundsEvent - | WindowExternalProcessStartedEvent - | WindowExternalProcessExited - | WindowGroupChangedEvent - | WindowHiddenEvent - | Window_NavigationRejectedEvent) => void, + addEventListener( + type: OpenFinWindowEventType, + listener: (event: WindowBaseEvent + | WindowAuthRequestedEvent + | WindowBoundsEvent + | WindowExternalProcessStartedEvent + | WindowExternalProcessExited + | WindowGroupChangedEvent + | WindowHiddenEvent + | Window_NavigationRejectedEvent) => void, callback?: () => void, errorCallback?: (reason: string) => void): void; /** * Performs the specified window transitions @@ -1167,7 +1217,8 @@ declare namespace fin { /** * Removes a previously registered event listener from the specified event. */ - removeEventListener(type: OpenFinWindowEventType, + removeEventListener( + type: OpenFinWindowEventType, listener: (event: WindowBaseEvent | WindowAuthRequestedEvent | WindowBoundsEvent @@ -1176,7 +1227,8 @@ declare namespace fin { | WindowGroupChangedEvent | WindowHiddenEvent | Window_NavigationRejectedEvent) => void, - callback?: () => void, errorCallback?: (reason: string) => void): void; + callback?: () => void, + errorCallback?: (reason: string) => void): void; /** * Resizes the window by a specified amount. */ diff --git a/types/openfin/v15/tslint.json b/types/openfin/v15/tslint.json index e4f5db4fa0..9a8c3325b5 100644 --- a/types/openfin/v15/tslint.json +++ b/types/openfin/v15/tslint.json @@ -1,6 +1,13 @@ { "extends": "../tslint.json", "rules": { - "max-line-length": false + "align": false, + "eofline": false, + "jsdoc-format": false, + "max-line-length": false, + "no-consecutive-blank-lines": false, + "no-padding": false, + "no-var": false, + "prefer-method-signature": false } } diff --git a/types/openfin/v16/tslint.json b/types/openfin/v16/tslint.json index c5090ea20a..719a831603 100644 --- a/types/openfin/v16/tslint.json +++ b/types/openfin/v16/tslint.json @@ -1,7 +1,17 @@ -{ - "extends": "../../tslint.json", +{ + "extends": "../../tslint.json", "rules": { + "align": false, + "comment-format": false, + "eofline": false, + "jsdoc-format": false, "max-line-length": false, - "only-arrow-functions-2": false + "no-padding": false, + "no-var": false, + "object-literal-key-quotes": false, + "object-literal-shorthand": false, + "only-arrow-functions": false, + "prefer-method-signature": false, + "space-before-function-paren": false } } \ No newline at end of file diff --git a/types/optics-agent/index.d.ts b/types/optics-agent/index.d.ts index 4d27ac71ae..902e8e8379 100644 --- a/types/optics-agent/index.d.ts +++ b/types/optics-agent/index.d.ts @@ -21,7 +21,7 @@ export interface Options { * * You shouldn't need to set this unless you are debugging. */ - normalizeQuery?: (graphQLResolveInfo: any) => string; + normalizeQuery?(graphQLResolveInfo: any): string; /** * Where to send the reports. Defaults to the production Optics endpoint, or the OPTICS_ENDPOINT_URL environment variable if it is set. diff --git a/types/pad/pad-tests.ts b/types/pad/pad-tests.ts index ccba560703..36befdac78 100644 --- a/types/pad/pad-tests.ts +++ b/types/pad/pad-tests.ts @@ -3,4 +3,4 @@ import pad = require('pad'); pad('pad', 5); // "pad " pad(5, 'pad'); // " pad" pad('pad', 5, '+'); // "pad++" -pad(5, 'pad', '+'); // "++pad" \ No newline at end of file +pad(5, 'pad', '+'); // "++pad" diff --git a/types/parsimmon/index.d.ts b/types/parsimmon/index.d.ts index 718fc1246d..21cd77ce2f 100644 --- a/types/parsimmon/index.d.ts +++ b/types/parsimmon/index.d.ts @@ -75,7 +75,7 @@ declare namespace Parsimmon { interface Parser { /** * parse the string - */ + */ parse(input: string): Result; /** * Like parser.parse(input) but either returns the parsed value or throws @@ -91,7 +91,7 @@ declare namespace Parsimmon { * returns a new parser which tries parser, and on success calls the given function * with the result of the parse, which is expected to return another parser, which * will be tried next - */ + */ chain(next: (result: T) => Parser): Parser; /** * returns a new parser which tries parser, and on success calls the given function @@ -254,8 +254,8 @@ declare namespace Parsimmon { type SuccessFunctionType = (index: number, result: U) => Result; type FailureFunctionType = (index: number, msg: string) => Result; type ParseFunctionType = (stream: StreamType, index: number) => Result; - /** - * allows to add custom primitive parsers. + /** + * allows to add custom primitive parsers. */ function custom(parsingFunction: (success: SuccessFunctionType, failure: FailureFunctionType) => ParseFunctionType): Parser; diff --git a/types/passport-anonymous/index.d.ts b/types/passport-anonymous/index.d.ts index a7c9e5b332..c997c92ff0 100644 --- a/types/passport-anonymous/index.d.ts +++ b/types/passport-anonymous/index.d.ts @@ -7,4 +7,4 @@ import * as passport from "passport"; export class Strategy implements passport.Strategy { authenticate: () => void; -} \ No newline at end of file +} diff --git a/types/path-is-absolute/path-is-absolute-tests.ts b/types/path-is-absolute/path-is-absolute-tests.ts index 6948e290fa..4fb87cf5f0 100644 --- a/types/path-is-absolute/path-is-absolute-tests.ts +++ b/types/path-is-absolute/path-is-absolute-tests.ts @@ -20,4 +20,4 @@ pathIsAbsolute.posix('C:/Users/foo'); pathIsAbsolute.win32('C:/Users/foo'); // => true pathIsAbsolute.win32('/home/foo'); -// => false \ No newline at end of file +// => false diff --git a/types/payment/payment-tests.ts b/types/payment/payment-tests.ts index 5601067419..b639b73127 100644 --- a/types/payment/payment-tests.ts +++ b/types/payment/payment-tests.ts @@ -1,16 +1,16 @@ import * as Payment from "payment"; -var input = document.getElementById('input') as HTMLInputElement; +const input = document.getElementById('input') as HTMLInputElement; Payment.restrictNumeric(input); Payment.formatCardNumber(input); Payment.formatCardExpiry(input); Payment.formatCardCVC(input); -var card = "1234 5678 9012 3456"; +const card = "1234 5678 9012 3456"; -var cardType = Payment.fns.cardType(card); +const cardType = Payment.fns.cardType(card); Payment.fns.validateCardNumber(card); Payment.fns.validateCardExpiry("1 / 20"); Payment.fns.validateCardExpiry("1", "20"); -Payment.fns.validateCardCVC("123", cardType); \ No newline at end of file +Payment.fns.validateCardCVC("123", cardType); diff --git a/types/pbf/pbf-tests.ts b/types/pbf/pbf-tests.ts index 39c67602d8..c0a8556c42 100644 --- a/types/pbf/pbf-tests.ts +++ b/types/pbf/pbf-tests.ts @@ -1,6 +1,6 @@ import Pbf = require('pbf'); -var pbf = new Pbf(new Uint8Array(1)); +const pbf = new Pbf(new Uint8Array(1)); new Pbf(); pbf.buf; pbf.pos; @@ -85,4 +85,4 @@ pbf.writeSVarintField(1, 2); pbf.writeStringField(1, ''); pbf.writeFloatField(1, 2); pbf.writeDoubleField(1, 2); -pbf.writeBooleanField(1, true); \ No newline at end of file +pbf.writeBooleanField(1, true); diff --git a/types/pem/index.d.ts b/types/pem/index.d.ts index c523fb8fa7..b65b60b9e1 100644 --- a/types/pem/index.d.ts +++ b/types/pem/index.d.ts @@ -144,9 +144,9 @@ type Callback = (error: any, result: T) => any; * @param {PrivateKeyCreationOptions} [options] private key encryption settings, defaults to empty object (no enryption) * @param {Callback<{ key: string }>} callback Callback function with an error object and {key} */ -declare function createPrivateKey(keyBitsize: number, options: PrivateKeyCreationOptions, callback: Callback<{ key: string }>): void; -declare function createPrivateKey(optionsOrKeyBitsize: number | PrivateKeyCreationOptions, callback: Callback<{ key: string }>): void; -declare function createPrivateKey(callback: Callback<{ key: string }>): void; +export function createPrivateKey(keyBitsize: number, options: PrivateKeyCreationOptions, callback: Callback<{ key: string }>): void; +export function createPrivateKey(optionsOrKeyBitsize: number | PrivateKeyCreationOptions, callback: Callback<{ key: string }>): void; +export function createPrivateKey(callback: Callback<{ key: string }>): void; /** * Creates a dhparam key @@ -154,8 +154,8 @@ declare function createPrivateKey(callback: Callback<{ key: string }>): void; * @param {Number} [keyBitsize=512] Size of the key, defaults to 512bit * @param {Callback<{ dhparam: any }>} callback Callback function with an error object and {dhparam} */ -declare function createDhparam(keyBitsize: number, callback: Callback<{ dhparam: any }>): void; -declare function createDhparam(callback: Callback<{ dhparam: any }>): void; +export function createDhparam(keyBitsize: number, callback: Callback<{ dhparam: any }>): void; +export function createDhparam(callback: Callback<{ dhparam: any }>): void; /** * Creates a Certificate Signing Request @@ -166,8 +166,8 @@ declare function createDhparam(callback: Callback<{ dhparam: any }>): void; * @param {CSRCreationOptions} [options] Optional options object * @param {Callback<{ csr: string, clientKey: string }>} callback Callback function with an error object and {csr, clientKey} */ -declare function createCSR(options: CSRCreationOptions, callback: Callback<{ csr: string, clientKey: string }>): void; -declare function createCSR(callback: Callback<{ csr: string, clientKey: string }>): void; +export function createCSR(options: CSRCreationOptions, callback: Callback<{ csr: string, clientKey: string }>): void; +export function createCSR(callback: Callback<{ csr: string, clientKey: string }>): void; /** * Creates a certificate based on a CSR. If CSR is not defined, a new one @@ -177,8 +177,8 @@ declare function createCSR(callback: Callback<{ csr: string, clientKey: string } * @param {Object} [CertificateCreationOptions] Optional options object * @param {Callback} callback Callback function with an error object and {certificate, csr, clientKey, serviceKey} */ -declare function createCertificate(options: CertificateCreationOptions, callback: Callback): void; -declare function createCertificate(callback: Callback): void; +export function createCertificate(options: CertificateCreationOptions, callback: Callback): void; +export function createCertificate(callback: Callback): void; /** * Reads subject data from a certificate or a CSR @@ -186,8 +186,8 @@ declare function createCertificate(callback: Callback * @param {String} certificate PEM encoded CSR or certificate * @param {Callback} callback Callback function with an error object and {country, state, locality, organization, organizationUnit, commonName, emailAddress} */ -declare function readCertificateInfo(certificate: string, callback: Callback): void; -declare function readCertificateInfo(callback: Callback): void; +export function readCertificateInfo(certificate: string, callback: Callback): void; +export function readCertificateInfo(callback: Callback): void; /** * Exports a public key from a private key, CSR or certificate @@ -195,8 +195,8 @@ declare function readCertificateInfo(callback: Callback} callback Callback function with an error object and {publicKey} */ -declare function getPublicKey(certificate: string, callback: Callback<{ publicKey: string }>): void; -declare function getPublicKey(callback: Callback<{ publicKey: string }>): void; +export function getPublicKey(certificate: string, callback: Callback<{ publicKey: string }>): void; +export function getPublicKey(callback: Callback<{ publicKey: string }>): void; /** * Gets the fingerprint for a certificate @@ -205,9 +205,9 @@ declare function getPublicKey(callback: Callback<{ publicKey: string }>): void; * @param {HashFunction} hash Hash function to use (either md5 sha1 or sha256, defaults to sha256) * @param {Callback<{ fingerprint: string }>} callback Callback function with an error object and {fingerprint} */ -declare function getFingerprint(certificate: string, hash: HashFunction, callback: Callback<{ fingerprint: string }>): void; -declare function getFingerprint(certificate: string, callback: Callback<{ fingerprint: string }>): void; -declare function getFingerprint(callback: Callback<{ fingerprint: string }>): void; +export function getFingerprint(certificate: string, hash: HashFunction, callback: Callback<{ fingerprint: string }>): void; +export function getFingerprint(certificate: string, callback: Callback<{ fingerprint: string }>): void; +export function getFingerprint(callback: Callback<{ fingerprint: string }>): void; /** * Gets the modulus from a certificate, a CSR or a private key @@ -216,8 +216,8 @@ declare function getFingerprint(callback: Callback<{ fingerprint: string }>): vo * @param {String} password password for the certificate * @param {Callback<{ modulus: any }>} callback Callback function with an error object and {modulus} */ -declare function getModulus(certificate: string, password: string, callback: Callback<{ modulus: any }>): void; -declare function getModulus(certificate: string, callback: Callback<{ modulus: any }>): void; +export function getModulus(certificate: string, password: string, callback: Callback<{ modulus: any }>): void; +export function getModulus(certificate: string, callback: Callback<{ modulus: any }>): void; /** * Gets the size and prime of DH parameters @@ -225,7 +225,7 @@ declare function getModulus(certificate: string, callback: Callback<{ modulus: a * @param {String} dh DH parameters PEM encoded * @param {Callback<{ size: any, prime: any }>} callback Callback function with an error object and {size, prime} */ -declare function getDhparamInfo(dh: string, callback: Callback<{ size: any, prime: any }>): void; +export function getDhparamInfo(dh: string, callback: Callback<{ size: any, prime: any }>): void; /** * Exports private key and certificate to a PKCS12 keystore @@ -236,8 +236,8 @@ declare function getDhparamInfo(dh: string, callback: Callback<{ size: any, prim * @param {Pkcs12CreationOptions} [options] object of cipher and optional client key password {cipher:'aes128', clientKeyPassword: 'xxx'} * @param {Callback<{ pkcs12: any }>} callback Callback function with an error object and {pkcs12} */ -declare function createPkcs12(key: string, certificate: string, password: string, options: Pkcs12CreationOptions, callback: Callback<{ pkcs12: any }>): void; -declare function createPkcs12(key: string, certificate: string, password: string, callback: Callback<{ pkcs12: any }>): void; +export function createPkcs12(key: string, certificate: string, password: string, options: Pkcs12CreationOptions, callback: Callback<{ pkcs12: any }>): void; +export function createPkcs12(key: string, certificate: string, password: string, callback: Callback<{ pkcs12: any }>): void; /** * Reads private key and certificate from a PKCS12 keystore @@ -246,8 +246,8 @@ declare function createPkcs12(key: string, certificate: string, password: string * @param {Function} callback Callback function with an error object and {pkcs12} * @returns the result of the callback */ -declare function readPkcs12(bufferOrPath: string, options: Pkcs12ReadOptions, callback: Callback<{ pkcs12: any }>): any; -declare function readPkcs12(bufferOrPath: string, callback: Callback<{ pkcs12: any }>): any; +export function readPkcs12(bufferOrPath: string, options: Pkcs12ReadOptions, callback: Callback<{ pkcs12: any }>): any; +export function readPkcs12(bufferOrPath: string, callback: Callback<{ pkcs12: any }>): any; /** * Verifies the signing chain of the passed certificate @@ -256,10 +256,10 @@ declare function readPkcs12(bufferOrPath: string, callback: Callback<{ pkcs12: a * @param {string[]} ca List of CA certificates * @param {Function} callback Callback function with an error object and a boolean valid */ -declare function verifySigningChain(certificate: string, ca: string[], callback: Callback): void; +export function verifySigningChain(certificate: string, ca: string[], callback: Callback): void; /** * config the pem module * @param {ModuleConfiguration} options */ -declare function config(options: ModuleConfiguration): void; +export function config(options: ModuleConfiguration): void; diff --git a/types/pem/pem-tests.ts b/types/pem/pem-tests.ts index 689dc42ad9..fe409b6560 100644 --- a/types/pem/pem-tests.ts +++ b/types/pem/pem-tests.ts @@ -1,10 +1,9 @@ import * as pem from 'pem'; const tests = { - 'Create default sized dhparam key': (test: any) => { pem.createDhparam((error: any, data: any) => { - var dhparam = (data && data.dhparam || '').toString(); + const dhparam = (data && data.dhparam || '').toString(); test.ifError(error); test.ok(dhparam); test.ok(dhparam.match(/^\n*\-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-\n/)); @@ -17,7 +16,7 @@ const tests = { 'Create 2048bit dhparam key': (test: any) => { pem.createDhparam(2048, (error: any, data: any) => { - var dhparam = (data && data.dhparam || '').toString(); + const dhparam = (data && data.dhparam || '').toString(); test.ifError(error); test.ok(dhparam); test.ok(dhparam.match(/^\n*\-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-\n/)); @@ -30,7 +29,7 @@ const tests = { 'Create default sized Private key': (test: any) => { pem.createPrivateKey((error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); test.ifError(error); test.ok(key); test.ok(key.match(/^\n*\-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-\n/)); @@ -43,7 +42,7 @@ const tests = { 'Create 2048bit Private key': (test: any) => { pem.createPrivateKey(2048, (error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); test.ifError(error); test.ok(key); test.ok(key.match(/^\n*\-\-\-\-\-BEGIN RSA PRIVATE KEY\-\-\-\-\-\n/)); @@ -56,7 +55,7 @@ const tests = { 'Create 2048bit Private key with Password': (test: any) => { pem.createPrivateKey(2048, {cipher: 'des', password: 'TestMe'}, (error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); test.ifError(error); test.ok(key); test.ok(key.match(/ENCRYPTED\n/)); @@ -70,7 +69,7 @@ const tests = { 'Create default CSR': (test: any) => { pem.createCSR((error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); test.ok(csr); test.ok(csr.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-\n/)); @@ -83,7 +82,7 @@ const tests = { }, 'Create CSR using config file': (test: any) => { - var certInfo = { + const certInfo = { issuer : {}, country: 'EE', state: 'Harjumaa', @@ -95,7 +94,7 @@ const tests = { }; pem.createCSR({ csrConfigFile: './test/fixtures/test.cnf' }, (error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); test.ok(csr); test.ok(csr.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-\n/)); @@ -115,12 +114,12 @@ const tests = { 'Create CSR with own key': (test: any) => { pem.createPrivateKey((error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); pem.createCSR({ clientKey: key }, (error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); test.ok(csr); test.ok(csr.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-\n/)); @@ -136,15 +135,15 @@ const tests = { }, 'Create CSR with own encrypted key': (test: any) => { - var password = 'my:secure! "password\'s\nawesome'; + const password = 'my:secure! "password\'s\nawesome'; pem.createPrivateKey(2048, { cipher: 'des3', password }, (error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); pem.createCSR({ clientKey: key, clientKeyPassword: password }, (error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); test.ok(csr); test.ok(csr.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE REQUEST\-\-\-\-\-\n/)); @@ -161,7 +160,7 @@ const tests = { 'Create default certificate': (test: any) => { pem.createCertificate((error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); test.ok(certificate); test.ok(certificate.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\n/)); @@ -181,7 +180,7 @@ const tests = { pem.createCertificate({ selfSigned: true }, (error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); test.ok(certificate); test.ok(certificate.match(/^\n*\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\n/)); @@ -199,7 +198,7 @@ const tests = { 'Read default cert data from CSR': (test: any) => { pem.createCSR((error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); // test.ok(fs.readdirSync('./tmp').length === 0); @@ -222,7 +221,7 @@ const tests = { }, 'Read edited cert data from CSR': (test: any) => { - var certInfo = { + const certInfo = { issuer : {}, country: 'EE', state: 'Harjumaa', @@ -233,7 +232,7 @@ const tests = { emailAddress: 'andris@node.ee' }; pem.createCSR(Object.create(certInfo), (error: any, data: any) => { - var csr = (data && data.csr || '').toString(); + const csr = (data && data.csr || '').toString(); test.ifError(error); // test.ok(fs.readdirSync('./tmp').length === 0); @@ -248,7 +247,7 @@ const tests = { 'Read default cert data from certificate': (test: any) => { pem.createCertificate((error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); // test.ok(fs.readdirSync('./tmp').length === 0); @@ -286,7 +285,7 @@ const tests = { }, 'Read edited cert data from certificate': (test: any) => { - var certInfo = { + const certInfo = { issuer : { country: 'EE', state: 'Harjumaa', @@ -304,7 +303,7 @@ const tests = { emailAddress: 'andris@node.ee' }; pem.createCertificate(Object.create(certInfo), (error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); // test.ok(fs.readdirSync('./tmp').length === 0); @@ -327,13 +326,13 @@ const tests = { 'Get public key from private key': (test: any) => { pem.createPrivateKey((error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); test.ifError(error); test.ok(key); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getPublicKey(key, (error: any, data: any) => { - var pubkey = (data && data.publicKey || '').toString(); + const pubkey = (data && data.publicKey || '').toString(); test.ifError(error); test.ok(pubkey); @@ -348,13 +347,13 @@ const tests = { 'Get public key from CSR': (test: any) => { pem.createCSR((error: any, data: any) => { - var key = (data && data.clientKey || '').toString(); + const key = (data && data.clientKey || '').toString(); test.ifError(error); test.ok(key); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getPublicKey(key, (error: any, data: any) => { - var pubkey = (data && data.publicKey || '').toString(); + const pubkey = (data && data.publicKey || '').toString(); test.ifError(error); test.ok(pubkey); @@ -369,13 +368,13 @@ const tests = { 'Get public key from certificate': (test: any) => { pem.createCertificate((error: any, data: any) => { - var key = (data && data.clientKey || '').toString(); + const key = (data && data.clientKey || '').toString(); test.ifError(error); test.ok(key); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getPublicKey(key, (error: any, data: any) => { - var pubkey = (data && data.publicKey || '').toString(); + const pubkey = (data && data.publicKey || '').toString(); test.ifError(error); test.ok(pubkey); @@ -390,13 +389,13 @@ const tests = { 'Get fingerprint from certificate': (test: any) => { pem.createCertificate((error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); test.ok(certificate); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getFingerprint(certificate, (error: any, data: any) => { - var fingerprint = (data && data.fingerprint || '').toString(); + const fingerprint = (data && data.fingerprint || '').toString(); test.ifError(error); test.ok(fingerprint); test.ok(fingerprint.match(/^[0-9A-F]{2}(:[0-9A-F]{2}){19}$/)); @@ -409,19 +408,19 @@ const tests = { 'Get modulus from certificate': (test: any) => { pem.createCertificate((error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); test.ok(certificate); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getModulus(certificate, (error: any, data: any) => { - var certmodulus = (data && data.modulus || '').toString(); + const certmodulus = (data && data.modulus || '').toString(); test.ifError(error); test.ok(certmodulus); test.ok(certmodulus.match(/^[0-9A-F]*$/)); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getModulus(certificate, (error: any, data: any) => { - var keymodulus = (data && data.modulus || '').toString(); + const keymodulus = (data && data.modulus || '').toString(); test.ifError(error); test.ok(keymodulus); test.ok(keymodulus.match(/^[0-9A-F]*$/)); @@ -434,17 +433,17 @@ const tests = { }, 'Get modulus from a protected key': (test: any) => { - var certificate = ''; // fs.readFileSync('./test/fixtures/test.crt').toString(); - var key = ''; // fs.readFileSync('./test/fixtures/test.key').toString(); + const certificate = ''; // fs.readFileSync('./test/fixtures/test.crt').toString(); + const key = ''; // fs.readFileSync('./test/fixtures/test.key').toString(); pem.getModulus(certificate, (error: any, data: any) => { - var certmodulus = (data && data.modulus || '').toString(); + const certmodulus = (data && data.modulus || '').toString(); test.ifError(error); test.ok(certmodulus); test.ok(certmodulus.match(/^[0-9A-F]*$/)); // test.ok(fs.readdirSync('./tmp').length === 0); pem.getModulus(key, 'password', (error: any, data: any) => { - var keymodulus = (data && data.modulus || '').toString(); + const keymodulus = (data && data.modulus || '').toString(); test.ifError(error); test.ok(keymodulus); test.ok(keymodulus.match(/^[0-9A-F]*$/)); @@ -453,15 +452,14 @@ const tests = { test.done(); }); }); - }, 'Get DH param info': (test: any) => { - var dh = ''; // fs.readFileSync('./test/fixtures/test.dh').toString(); + const dh = ''; // fs.readFileSync('./test/fixtures/test.dh').toString(); pem.getDhparamInfo(dh, (error: any, data: any) => { - var size = data && data.size || 0; - var prime = (data && data.prime || '').toString(); + const size = data && data.size || 0; + const prime = (data && data.prime || '').toString(); test.ifError(error); test.equal(size, 1024); test.ok(prime); @@ -473,11 +471,11 @@ const tests = { }, 'Create and verify wildcard certificate': (test: any) => { - var certInfo = { + const certInfo = { commonName: '*.node.ee' }; pem.createCertificate(Object.create(certInfo), (error: any, data: any) => { - var certificate = (data && data.certificate || '').toString(); + const certificate = (data && data.certificate || '').toString(); test.ifError(error); // test.ok(fs.readdirSync('./tmp').length === 0); @@ -507,13 +505,12 @@ const tests = { }, 'Create PKCS12 without key password': (test: any) => { pem.createPrivateKey((error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); pem.createCertificate({ clientKey: key, selfSigned: true }, (error: any, csr: any) => { - pem.createPkcs12(csr.clientKey, csr.certificate, 'mypassword', (err: any, pkcs12: any) => { test.ifError(err); test.ok(pkcs12); @@ -526,13 +523,12 @@ const tests = { }, 'Create PKCS12 with key password': (test: any) => { pem.createPrivateKey({cipher: 'aes128', password: 'xxx'}, (error: any, data: any) => { - var key = (data && data.key || '').toString(); + const key = (data && data.key || '').toString(); pem.createCertificate({ clientKey: key, selfSigned: true }, (error: any, csr: any) => { - pem.createPkcs12(csr.clientKey, csr.certificate, 'mypassword', {cipher: 'aes256', clientKeyPassword: 'xxx'}, (err: any, pkcs12: any) => { test.ifError(err); test.ok(pkcs12); diff --git a/types/phonon/phonon-tests.ts b/types/phonon/phonon-tests.ts index 6b9851b642..c31fcbbabb 100644 --- a/types/phonon/phonon-tests.ts +++ b/types/phonon/phonon-tests.ts @@ -42,7 +42,6 @@ phonon.navigator().changePage('page-name', 'optional-parameter'); let page: string = phonon.navigator().currentPage; page = phonon.navigator().previousPage; - let ev = document.createEvent(''); document.on('pagecreated', event => { console.log('global state pagecreated: ' + event.detail.page); @@ -71,7 +70,7 @@ phonon.i18n().getPreference(); phonon.i18n().getLocale(); // Code examples from http://phonon.quarkdev.com/docs/ajax -var req = phonon.ajax({ +const req = phonon.ajax({ method: 'GET', url: 'http://mysite.com/api/', crossDomain: true, @@ -127,7 +126,7 @@ phonon.sidePanel('#side-panel-id').close(); let pAlert = phonon.alert("text", "title", true, "textOk"); pAlert.on('confirm', () => {}); -var pconfirm = phonon.confirm("text", "title", true, "textOk", "textCancel"); +const pconfirm = phonon.confirm("text", "title", true, "textOk", "textCancel"); pconfirm.on('confirm', () => {}); pconfirm.on('cancel', () => {}); @@ -166,8 +165,8 @@ popover.setList([ } ]); popover.setList(['a', 'b', 'c'], item => { - var text = typeof item === 'string' ? item : item.text; - var value = typeof item === 'string' ? item : item.value; + const text = typeof item === 'string' ? item : item.text; + const value = typeof item === 'string' ? item : item.value; return '
  • ' + text + '
    • '; }); @@ -196,7 +195,6 @@ popover = phonon.popover() phonon.preloader('#my-preloader').show(); phonon.preloader('#my-preloader').hide(); - // Code examples from http://phonon.quarkdev.com/docs/tabs let tabNumber = 2; phonon.tab().setCurrentTab('pageName', tabNumber); @@ -219,8 +217,8 @@ let app = phonon.navigator(); app.on({page: 'home', preventClose: false, content: null}); app.on({page: 'pagetwo', preventClose: true, content: 'pagetwo.html', readyDelay: 1}, activity => { let action: string | null = null; - var onAction = (evt: any) => { - var target = evt.target; + const onAction = (evt: any) => { + const target = evt.target; action = 'ok'; if (target.getAttribute('data-order') === 'order') { phonon.alert('Thank you for your order!', 'Dear customer'); @@ -272,7 +270,7 @@ phonon.options({ } }); -var app2 = phonon.navigator(); +const app2 = phonon.navigator(); app2.on({page: 'home', content: 'home.html'}); app2.on({page: 'pagedialog', content: 'pagedialog.html'}, activity => { activity.onCreate(() => { @@ -299,7 +297,7 @@ app2.on({page: 'pagedialog', content: 'pagedialog.html'}, activity => { const showPrompt = document.querySelector('#show-prompt'); if (showPrompt) { showPrompt.on('tap', () => { - var prompt = phonon.prompt('Example', 'Hello'); + const prompt = phonon.prompt('Example', 'Hello'); prompt.on('confirm', value => { phonon.alert(value, 'Inserted Value'); }); @@ -417,7 +415,7 @@ phonon.navigator().on({ page: 'home' }, activity => { const input = document.querySelector( '#searchJS' ); let list = ''; // external autocomplete - var req = phonon.ajax({ + const req = phonon.ajax({ method: "GET", url: 'https://restcountries.eu/rest/v1/lang/en', dataType: "json", @@ -461,7 +459,7 @@ app3.on({page: 'home', content: null}, activity => { element = document.querySelector('#show-confirm'); if (element) { element.on('tap', () => { - var confirm = phonon.confirm('Example', 'Hello'); + const confirm = phonon.confirm('Example', 'Hello'); confirm.on('confirm', () => { phonon.alert('Confirmed!'); }); @@ -474,7 +472,7 @@ app3.on({page: 'home', content: null}, activity => { element = document.querySelector('#show-prompt'); if (element) { element.on('tap', () => { - var prompt = phonon.prompt('Example', 'Hello'); + const prompt = phonon.prompt('Example', 'Hello'); prompt.on('confirm', value => { phonon.alert(value, 'Inserted Value'); }); @@ -487,7 +485,7 @@ app3.on({page: 'home', content: null}, activity => { element = document.querySelector('#show-indicator'); if (element) { element.on('tap', () => { - var indicator = phonon.indicator('Please wait 3 seconds', false); + const indicator = phonon.indicator('Please wait 3 seconds', false); window.setTimeout(() => { indicator.close(); }, 3000); @@ -523,9 +521,9 @@ function setupHTML() { phonon.i18n().bind(); } -var setPreference = (evt: any) => { - var target = evt.target; - var lang = target.getAttribute('data-l'); +const setPreference = (evt: any) => { + const target = evt.target; + const lang = target.getAttribute('data-l'); if (lang) { phonon.updateLocale(lang); } diff --git a/types/pikaday-time/index.d.ts b/types/pikaday-time/index.d.ts index 1fcb92a7ed..d1cd056b79 100644 --- a/types/pikaday-time/index.d.ts +++ b/types/pikaday-time/index.d.ts @@ -226,7 +226,7 @@ declare namespace Pikaday { * Callback function that gets passed a Date object for each day * in view. Should return true to disable selection of that day. */ - disableDayFn?: (date: Date) => boolean; + disableDayFn?(date: Date): boolean; /** * Number of years either side (e.g. 10) or array of upper/lower range @@ -285,22 +285,22 @@ declare namespace Pikaday { /** * Callback function for when a date is selected. */ - onSelect?: (date: Date) => void; + onSelect?(date: Date): void; /** * Callback function for when the picker becomes visible. */ - onOpen?: () => void; + onOpen?(): void; /** * Callback function for when the picker is hidden. */ - onClose?: () => void; + onClose?(): void; /** * Callback function for when the picker draws a new month. */ - onDraw?: () => void; + onDraw?(): void; /*--pikaday-time specific addition--*/ /** diff --git a/types/pikaday-time/pikaday-time-tests.ts b/types/pikaday-time/pikaday-time-tests.ts index 3dcaf17dcd..fec72dc553 100644 --- a/types/pikaday-time/pikaday-time-tests.ts +++ b/types/pikaday-time/pikaday-time-tests.ts @@ -7,8 +7,8 @@ new Pikaday({field: document.getElementById('datepicker')}); new Pikaday({field: $('#datepicker')[0]}); (() => { - var field: HTMLInputElement = document.getElementById('datepicker'); - var picker = new Pikaday({ + const field: HTMLInputElement = document.getElementById('datepicker'); + const picker = new Pikaday({ onSelect(date: Date) { field.value = picker.toString(); console.log(date.toISOString()); @@ -18,7 +18,7 @@ new Pikaday({field: $('#datepicker')[0]}); })(); (() => { - var picker = new Pikaday({ + const picker = new Pikaday({ field: document.getElementById('datepicker'), format: 'D MMM YYYY', onSelect() { @@ -50,7 +50,7 @@ new Pikaday({field: $('#datepicker')[0]}); })(); (() => { - var i18n: Pikaday.PikadayI18nConfig = { + const i18n: Pikaday.PikadayI18nConfig = { previousMonth: 'Previous Month', nextMonth: 'Next Month', months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], diff --git a/types/pixi.js/index.d.ts b/types/pixi.js/index.d.ts index d7a71abcef..81e0cf5637 100644 --- a/types/pixi.js/index.d.ts +++ b/types/pixi.js/index.d.ts @@ -800,7 +800,7 @@ declare namespace PIXI { context: CanvasRenderingContext2D | null; - render(displayObject: PIXI.DisplayObject, renderTexture?: PIXI.RenderTexture, clear?: boolean, transform?: PIXI.Transform, skipUpdateTransform?: boolean): void + render(displayObject: PIXI.DisplayObject, renderTexture?: PIXI.RenderTexture, clear?: boolean, transform?: PIXI.Transform, skipUpdateTransform?: boolean): void; setBlendMode(blendMode: number): void; destroy(removeView?: boolean): void; clear(clearColor?: string): void; @@ -887,7 +887,7 @@ declare namespace PIXI { _activeRenderTarget: RenderTarget; protected _initContext(): void; - render(displayObject: PIXI.DisplayObject, renderTexture?: PIXI.RenderTexture, clear?: boolean, transform?: PIXI.Transform, skipUpdateTransform?: boolean): void + render(displayObject: PIXI.DisplayObject, renderTexture?: PIXI.RenderTexture, clear?: boolean, transform?: PIXI.Transform, skipUpdateTransform?: boolean): void; setObjectRenderer(objectRenderer: ObjectRenderer): void; flush(): void; setBlendMode(blendMode: number): void; diff --git a/types/plotly.js/index.d.ts b/types/plotly.js/index.d.ts index 1fbdf3942c..c35811aa4d 100644 --- a/types/plotly.js/index.d.ts +++ b/types/plotly.js/index.d.ts @@ -6,277 +6,276 @@ declare namespace Plots { interface StaticPlots { - resize: (root: Plotly.Root) => void + resize(root: Plotly.Root): void; } } declare namespace Plotly { - type Root = string | HTMLElement + type Root = string | HTMLElement; interface PlotlyStatic { - Plots: Plots.StaticPlots - newPlot: (root: Root, data: Partial[], layout?: Partial, config?: Partial) => void - relayout: (root: Root, layout: Partial) => void - redraw: (root: Root) => void - purge: (root: Root) => void - d3: any + Plots: Plots.StaticPlots; + newPlot(root: Root, data: Array>, layout?: Partial, config?: Partial): void; + relayout(root: Root, layout: Partial): void; + redraw(root: Root): void; + purge(root: Root): void; + d3: any; } // Layout interface Layout { - autosize: boolean - showlegend: boolean - xaxis: Partial - yaxis: Partial - margin: Partial - height: number - width: number - hovermode: "closest" | "x" | "y" | false - 'xaxis.range': [Datum, Datum] - 'yaxis.range': [Datum, Datum] - 'yaxis.type': AxisType - 'xaxis.type': AxisType - 'xaxis.autorange': boolean - 'yaxis.autorange': boolean - shapes: Partial[] + autosize: boolean; + showlegend: boolean; + xaxis: Partial; + yaxis: Partial; + margin: Partial; + height: number; + width: number; + hovermode: "closest" | "x" | "y" | false; + 'xaxis.range': [Datum, Datum]; + 'yaxis.range': [Datum, Datum]; + 'yaxis.type': AxisType; + 'xaxis.type': AxisType; + 'xaxis.autorange': boolean; + 'yaxis.autorange': boolean; + shapes: Array>; } - type AxisType = "date" | "log" | "linear" + type AxisType = "date" | "log" | "linear"; interface Axis { - showgrid: boolean - fixedrange: boolean - rangemode: "tozero" | 'normal' | 'nonnegative' - type: AxisType - tickformat: string - hoverformat: string - rangeslider: Partial - rangeselector: Partial, - range: [Datum, Datum] - showticklabels: boolean - autotick: boolean - zeroline: boolean - autorange: boolean | 'reversed' + showgrid: boolean; + fixedrange: boolean; + rangemode: "tozero" | 'normal' | 'nonnegative'; + type: AxisType; + tickformat: string; + hoverformat: string; + rangeslider: Partial; + rangeselector: Partial; + range: [Datum, Datum]; + showticklabels: boolean; + autotick: boolean; + zeroline: boolean; + autorange: boolean | 'reversed'; } interface ShapeLine { - color: string - width: number - dash: Dash + color: string; + width: number; + dash: Dash; } interface Shape { - visible: boolean - layer: 'below' | 'above' - type: 'rect' | 'circle' | 'line' | 'path' - path: string + visible: boolean; + layer: 'below' | 'above'; + type: 'rect' | 'circle' | 'line' | 'path'; + path: string; // x-reference is assigned to the x-values - xref: 'x' | 'paper' + xref: 'x' | 'paper'; // y-reference is assigned to the plot paper [0,1] - yref: 'paper' | 'y' - x0: Datum - y0: Datum - x1: Datum - y1: Datum - fillcolor: string - opacity: number - line: Partial + yref: 'paper' | 'y'; + x0: Datum; + y0: Datum; + x1: Datum; + y1: Datum; + fillcolor: string; + opacity: number; + line: Partial; } interface Margin { - t: number - b: number - l: number - r: number + t: number; + b: number; + l: number; + r: number; } type ModeBarButtons = 'lasso2d' | 'select2d' | 'sendDataToCloud' | 'autoScale2d' | 'zoom2d' | 'pan2d' | 'zoomIn2d' | 'zoomOut2d' | 'autoScale2d' | 'resetScale2d' | - 'hoverClosestCartesian' | 'hoverCompareCartesian' | 'zoom3d' | 'pan3d' | 'orbitRotation' | - 'tableRotation' | 'resetCameraDefault3d' | 'resetCameraLastSave3d' | 'hoverClosest3d' | - 'zoomInGeo' | 'zoomOutGeo' | 'resetGeo' | 'hoverClosestGeo' | 'hoverClosestGl2d' | - 'hoverClosestPie' | 'toggleHover' | 'resetViews' + 'hoverClosestCartesian' | 'hoverCompareCartesian' | 'zoom3d' | 'pan3d' | 'orbitRotation' | + 'tableRotation' | 'resetCameraDefault3d' | 'resetCameraLastSave3d' | 'hoverClosest3d' | + 'zoomInGeo' | 'zoomOutGeo' | 'resetGeo' | 'hoverClosestGeo' | 'hoverClosestGl2d' | + 'hoverClosestPie' | 'toggleHover' | 'resetViews'; // Data - type Datum = string | number | Date + type Datum = string | number | Date; - type Dash = 'solid' | 'dot' | 'dash' | 'longdash' | 'dashdot' | 'longdashdot' + type Dash = 'solid' | 'dot' | 'dash' | 'longdash' | 'dashdot' | 'longdashdot'; - type Data = ScatterData | BarData + type Data = ScatterData | BarData; // Bar interface BarData { - type: 'bar' - x: Datum[] - y: Datum[] + type: 'bar'; + x: Datum[]; + y: Datum[]; } // Scatter interface ScatterData { - type: 'scatter' | 'scattergl' - x: Datum[] - y: Datum[] - text: string | string[] - line: Partial - marker: Partial - mode: "lines" | "markers" | "text" | "lines+markers" | "text+markers" | "text+lines" | "text+lines+markers" | "none" - hoveron: "points" | "fills" - hoverinfo: "text" - fill: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' | 'toself' | 'tonext' - fillcolor: string - legendgroup: string - name: string - connectgaps: boolean + type: 'scatter' | 'scattergl'; + x: Datum[]; + y: Datum[]; + text: string | string[]; + line: Partial; + marker: Partial; + mode: "lines" | "markers" | "text" | "lines+markers" | "text+markers" | "text+lines" | "text+lines+markers" | "none"; + hoveron: "points" | "fills"; + hoverinfo: "text"; + fill: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' | 'toself' | 'tonext'; + fillcolor: string; + legendgroup: string; + name: string; + connectgaps: boolean; } interface ScatterMarker { - symbol: "" //Drawing.symbolList - opacity: number - size: number - maxdisplayed: number - sizeref: number - sizemin: number - sizemode: "diameter" | "area" - showscale: boolean - line: {} //TODO - colorbar: {} //TODO + symbol: ""; // Drawing.symbolList + opacity: number; + size: number; + maxdisplayed: number; + sizeref: number; + sizemin: number; + sizemode: "diameter" | "area"; + showscale: boolean; + line: {}; // TODO + colorbar: {}; // TODO } interface ScatterLine { - color: string - width: number - dash: Dash - shape: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv' - smoothing: number - simplify: boolean + color: string; + width: number; + dash: Dash; + shape: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv'; + smoothing: number; + simplify: boolean; } interface Font { - family: string - size: number - color: string + family: string; + size: number; + color: string; } interface Config { // no interactivity, for export or image generation - staticPlot: boolean + staticPlot: boolean; // we can edit titles, move annotations, etc - editable: boolean + editable: boolean; // DO autosize once regardless of layout.autosize // (use default width or height values otherwise) - autosizable: boolean + autosizable: boolean; // set the length of the undo/redo queue - queueLength: number + queueLength: number; // if we DO autosize, do we fill the container or the screen? - fillFrame: boolean + fillFrame: boolean; // if we DO autosize, set the frame margins in percents of plot size - frameMargins: number + frameMargins: number; // mousewheel or two-finger scroll zooms the plot - scrollZoom: boolean + scrollZoom: boolean; // double click interaction (false, 'reset', 'autosize' or 'reset+autosize') - doubleClick: 'reset+autosize' | 'reset' | 'autosize' | false + doubleClick: 'reset+autosize' | 'reset' | 'autosize' | false; // new users see some hints about interactivity - showTips: boolean + showTips: boolean; // link to open this plot in plotly - showLink: boolean + showLink: boolean; // if we show a link, does it contain data or just link to a plotly file? - sendData: boolean + sendData: boolean; // text appearing in the sendData link - linkText: string + linkText: string; // false or function adding source(s) to linkText - showSources: boolean + showSources: boolean; // display the mode bar (true, false, or 'hover') - displayModeBar: 'hover' | boolean + displayModeBar: 'hover' | boolean; // remove mode bar button by name // (see ./components/modebar/buttons.js for the list of names) - modeBarButtonsToRemove: ModeBarButtons[], + modeBarButtonsToRemove: ModeBarButtons[]; // add mode bar button using config objects // (see ./components/modebar/buttons.js for list of arguments) - modeBarButtonsToAdd: ModeBarButtons[], + modeBarButtonsToAdd: ModeBarButtons[]; // fully custom mode bar buttons as nested array, // where the outer arrays represents button groups, and // the inner arrays have buttons config objects or names of default buttons // (see ./components/modebar/buttons.js for more info) - modeBarButtons: boolean + modeBarButtons: boolean; // add the plotly logo on the end of the mode bar - displaylogo: boolean + displaylogo: boolean; // increase the pixel ratio for Gl plot images - plotGlPixelRatio: number + plotGlPixelRatio: number; // function to add the background color to a different container // or 'opaque' to ensure there's white behind it - setBackground: string | 'opaque' + setBackground: string | 'opaque'; // URL to topojson files used in geo charts - topojsonURL: string + topojsonURL: string; // Mapbox access token (required to plot mapbox trace types) // If using an Mapbox Atlas server, set this option to '', // so that plotly.js won't attempt to authenticate to the public Mapbox server. - mapboxAccessToken: string + mapboxAccessToken: string; // Turn all console logging on or off (errors will be thrown) // This should ONLY be set via Plotly.setPlotConfig - logging: boolean + logging: boolean; // Set global transform to be applied to all traces with no // specification needed - globalTransforms: any[] - + globalTransforms: any[]; } // Components interface RangeSlider { - visible: boolean - thickness: number - range: [Datum, Datum] - borderwidth: number - bordercolor: string - bgcolor: string + visible: boolean; + thickness: number; + range: [Datum, Datum]; + borderwidth: number; + bordercolor: string; + bgcolor: string; } interface RangeSelectorButton { - step: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year' | 'all' - stepmode: 'backward' | 'todate' - count: number - label: string + step: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year' | 'all'; + stepmode: 'backward' | 'todate'; + count: number; + label: string; } interface RangeSelector { - buttons: Partial[] - visible: boolean - x: number - xanchor: 'auto' | 'left' | 'center' | 'right' - y: number - yanchor: 'auto' | 'top' | 'middle' | 'bottom' - bgcolor: string - activecolor: string - bordercolor: string - borderwidth: number - font: Partial + buttons: Array>; + visible: boolean; + x: number; + xanchor: 'auto' | 'left' | 'center' | 'right'; + y: number; + yanchor: 'auto' | 'top' | 'middle' | 'bottom'; + bgcolor: string; + activecolor: string; + bordercolor: string; + borderwidth: number; + font: Partial; } } -declare var Plotly: Plotly.PlotlyStatic -export = Plotly \ No newline at end of file +declare var Plotly: Plotly.PlotlyStatic; +export = Plotly; diff --git a/types/plotly.js/plotly.js-tests.ts b/types/plotly.js/plotly.js-tests.ts index 293c5ade6a..ab71c73e7d 100644 --- a/types/plotly.js/plotly.js-tests.ts +++ b/types/plotly.js/plotly.js-tests.ts @@ -1,6 +1,6 @@ import * as Plotly from 'plotly.js'; -var data: Plotly.BarData[] = [ +const data: Plotly.BarData[] = [ { x: ['giraffes', 'orangutans', 'monkeys'], y: [20, 14, 23], diff --git a/types/plugapi/index.d.ts b/types/plugapi/index.d.ts index 82782a1934..e1c61ce792 100644 --- a/types/plugapi/index.d.ts +++ b/types/plugapi/index.d.ts @@ -3,20 +3,19 @@ // Definitions by: Brice Theurillat // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace PlugAPI { - - export interface PlugLogin { + interface PlugLogin { email: string; password: string; } - export interface Notification { + interface Notification { action: string; id: number; timestamp: string; value: string; } - export interface RawChatMessage { + interface RawChatMessage { cid: string; message: string; sub: number; @@ -24,7 +23,7 @@ declare namespace PlugAPI { un: string; } - export interface Media { + interface Media { author: string; format: number; image: string; @@ -34,7 +33,7 @@ declare namespace PlugAPI { id: number; } - export interface Score { + interface Score { positive: number; listeners: number; grabs: number; @@ -42,23 +41,23 @@ declare namespace PlugAPI { skipped: number; } - export interface LastPlay { + interface LastPlay { dj: User.DJ; media: Media; score: Score; } - export interface FollowJoinData { + interface FollowJoinData { r: number; un: string; id: string; } - export interface LogObject { - log: () => void; + interface LogObject { + log(): void; } - export namespace User { + namespace User { interface Default { username: string; language: string; @@ -110,7 +109,7 @@ declare namespace PlugAPI { } } - export namespace Enum { + namespace Enum { interface RoomRole { NONE: number; RESIDENTDJ: number; @@ -217,7 +216,7 @@ declare namespace PlugAPI { } } - export namespace Event { + namespace Event { interface BoothCycle { moderator: string; cycle: boolean; @@ -339,21 +338,21 @@ declare namespace PlugAPI { interface Command extends Event.Chat { command: string; args: string[]; - respond: (...args: any[]) => any; - respondTimeout: (...args: any[]) => any; - havePermission: (...args: any[]) => boolean; - isFrom: (...args: any[]) => boolean; + respond(...args: any[]): any; + respondTimeout(...args: any[]): any; + havePermission(...args: any[]): boolean; + isFrom(...args: any[]): boolean; } } - export var ROOM_ROLE: Enum.RoomRole; - export var GLOBAL_ROLES: Enum.GlobalRole; - export var STATUS: Enum.Status; - export var BAN: Enum.Ban; - export var BAN_REASON: Enum.BanReason; - export var MUTE: Enum.Mute; - export var MUTE_REASON: Enum.MuteReason; - export var events: Enum.Events; + const ROOM_ROLE: Enum.RoomRole; + const GLOBAL_ROLES: Enum.GlobalRole; + const STATUS: Enum.Status; + const BAN: Enum.Ban; + const BAN_REASON: Enum.BanReason; + const MUTE: Enum.Mute; + const MUTE_REASON: Enum.MuteReason; + const events: Enum.Events; } declare class PlugAPI { @@ -412,4 +411,5 @@ declare class PlugAPI { on(event: "command", callback: (data: PlugAPI.Event.Command) => void): void; on(event: string, callback: (data: any) => void): void; } + export = PlugAPI; diff --git a/types/prismjs/index.d.ts b/types/prismjs/index.d.ts index 531dfe9b8f..b08c907bde 100644 --- a/types/prismjs/index.d.ts +++ b/types/prismjs/index.d.ts @@ -38,7 +38,6 @@ export function highlightAll(async: boolean, callback?: (element: Element) => vo */ export function highlightElement(element: Element, async: boolean, callback?: (element: Element) => void): void; - /** * Low-level function, only use if you know what you’re doing. It accepts a string of text as input and the language * definitions to use, and returns a string with the HTML produced. @@ -144,7 +143,6 @@ interface LanguageDefinition { } interface Languages { - /** Get a defined language's definition */ [key: string]: LanguageDefinition; diff --git a/types/prismjs/prismjs-tests.ts b/types/prismjs/prismjs-tests.ts index 137dad7ece..bf1bdc859a 100644 --- a/types/prismjs/prismjs-tests.ts +++ b/types/prismjs/prismjs-tests.ts @@ -1,5 +1,5 @@ -var element = document.createElement("code"); -var callback = (element: Element) => console.log(element); +const element = document.createElement("code"); +const callback = (element: Element) => console.log(element); Prism.highlightElement(element, false, callback); Prism.highlightElement(element, false); @@ -10,8 +10,8 @@ const hookCallback: Prism.HookCallback = env => null; Prism.hooks.add("before-highlightall", hookCallback); Prism.hooks.add("future-hook", hookCallback); -var language = "js"; -var tokens = Prism.tokenize("var n = 1;", Prism.languages[language]); +const language = "js"; +const tokens = Prism.tokenize("var n = 1;", Prism.languages[language]); (function visit(token: Prism.TokenNode): Prism.TokenNode { if (typeof token === "string") { return token; diff --git a/types/progressbar/progressbar-tests.ts b/types/progressbar/progressbar-tests.ts index 46dcc60732..b75e110adb 100644 --- a/types/progressbar/progressbar-tests.ts +++ b/types/progressbar/progressbar-tests.ts @@ -1,8 +1,8 @@ import { Progressbar, create } from 'progressbar'; -let str: string = '', - progressbar: Progressbar, - num: number = 1; +let str: string = ''; +let progressbar: Progressbar; +let num: number = 1; const fn: () => void = () => {}; progressbar = create(); diff --git a/types/proj4/index.d.ts b/types/proj4/index.d.ts index ff2b8334de..afba494556 100644 --- a/types/proj4/index.d.ts +++ b/types/proj4/index.d.ts @@ -38,28 +38,28 @@ declare namespace proj4 { inverse(coordinates: TemplateCoordinates): number[]; } - export const defaultDatum: string; + const defaultDatum: string; - export function Proj(srsCode: any, callback?: any): InterfaceProjection; + function Proj(srsCode: any, callback?: any): InterfaceProjection; - export const WGS84: any; + const WGS84: any; /** * Depecrated v3 */ - export function Point(x: number, y: number, z?: number): InterfaceCoordinates; - export function Point(coordinates: TemplateCoordinates | string): InterfaceCoordinates; + function Point(x: number, y: number, z?: number): InterfaceCoordinates; + function Point(coordinates: TemplateCoordinates | string): InterfaceCoordinates; - export function toPoint(array: number[]): InterfaceCoordinates; + function toPoint(array: number[]): InterfaceCoordinates; - export function defs(name: string, projection?: string): any; - export function defs(name: string[][]): any; + function defs(name: string, projection?: string): any; + function defs(name: string[][]): any; - export function transform(source: InterfaceProjection, dest: InterfaceProjection, point: TemplateCoordinates): any; + function transform(source: InterfaceProjection, dest: InterfaceProjection, point: TemplateCoordinates): any; - export function mgrs(coordinates: number[], accuracy: number): string; + function mgrs(coordinates: number[], accuracy: number): string; - export const version: string; + const version: string; } declare function proj4(fromProjection: string, toProjection?: string, coordinates?: proj4.TemplateCoordinates): proj4.Static; diff --git a/types/proj4/proj4-tests.ts b/types/proj4/proj4-tests.ts index 2c658b8f24..c5d549efe7 100644 --- a/types/proj4/proj4-tests.ts +++ b/types/proj4/proj4-tests.ts @@ -46,4 +46,4 @@ proj4.toPoint([1, 2, 3, 4]); // Point // WARNING: Deprecated in v3 -proj4.Point([1, 2, 3, 4]); \ No newline at end of file +proj4.Point([1, 2, 3, 4]); diff --git a/types/pulltorefreshjs/index.d.ts b/types/pulltorefreshjs/index.d.ts index e26af8e54c..2eab5b6741 100644 --- a/types/pulltorefreshjs/index.d.ts +++ b/types/pulltorefreshjs/index.d.ts @@ -7,111 +7,110 @@ export function init(options?: Options): void; export interface Options { /** - * Minimum distance required to trigger the refresh. - * (default: `60`) - */ + * Minimum distance required to trigger the refresh. + * (default: `60`) + */ distThreshold?: number; /** - * Maximum distance possible for the element. - * (default: `80`) - */ + * Maximum distance possible for the element. + * (default: `80`) + */ distMax?: number; /** - * After the `distThreshold` is reached and released, the element will have this height. - * (default: `50`) - */ + * After the `distThreshold` is reached and released, the element will have this height. + * (default: `50`) + */ distReload?: number; /** - * Before which element the pull to refresh elements will be? - * (default: `body`) - */ + * Before which element the pull to refresh elements will be? + * (default: `body`) + */ mainElement?: string; /** - * Which element should trigger the pull to refresh? - * (default: `body`) - */ + * Which element should trigger the pull to refresh? + * (default: `body`) + */ triggerElement?: string; /** - * What class will the main element have? - * (default: `.ptr`) - */ + * What class will the main element have? + * (default: `.ptr`) + */ ptrElement?: string; /** - * What class prefix for the elements? - * (default: `ptr--`) - */ + * What class prefix for the elements? + * (default: `ptr--`) + */ classPrefix?: string; /** - * What property will be used to calculate the element's proportions? - * (default: `min-height`) - */ + * What property will be used to calculate the element's proportions? + * (default: `min-height`) + */ cssProp?: string; /** - * The icon for both `instructionsPullToRefresh` and `instructionsReleaseToRefresh` - * (default: `⇣`) - */ + * The icon for both `instructionsPullToRefresh` and `instructionsReleaseToRefresh` + * (default: `⇣`) + */ iconArrow?: string; /** - * The icon when the refresh is in progress. - * (default: `…`) - */ + * The icon when the refresh is in progress. + * (default: `…`) + */ iconRefreshing?: string; /** - * The initial instructions string. - * (default: `Pull down to refresh`) - */ + * The initial instructions string. + * (default: `Pull down to refresh`) + */ instructionsPullToRefresh?: string; /** - * The instructions string when the `distThreshold` has been reached. - * (default: `Release to refresh`) - */ + * The instructions string when the `distThreshold` has been reached. + * (default: `Release to refresh`) + */ instructionsReleaseToRefresh?: string; /** - * The refreshing text. - * (default: `Refreshing`) - */ + * The refreshing text. + * (default: `Refreshing`) + */ instructionsRefreshing?: string; /** - * The delay, in milliseconds before the `onRefresh` is triggered. - * (default: `500`) - */ + * The delay, in milliseconds before the `onRefresh` is triggered. + * (default: `500`) + */ refreshTimeout?: number; /** - * The initialize function. - */ - onInit?: () => void; + * The initialize function. + */ + onInit?(): void; /** - * What will the pull to refresh trigger? You can return a promise. - * - * Defaults to `window.location.reload()` - */ + * What will the pull to refresh trigger? You can return a promise. + * + * Defaults to `window.location.reload()` + */ onRefresh?: (() => PromiseLike) | (() => void); - /** - * The resistance function, accepts one parameter, must return a number, capping at 1. - * - * Defaults to `t => Math.min(1, t / 2.5)` - */ - resistanceFunction?: (input: number) => number; + * The resistance function, accepts one parameter, must return a number, capping at 1. + * + * Defaults to `t => Math.min(1, t / 2.5)` + */ + resistanceFunction?(input: number): number; } /** * If no loader is present, this module is available as a global. */ -export as namespace PullToRefresh; \ No newline at end of file +export as namespace PullToRefresh; diff --git a/types/pulltorefreshjs/pulltorefreshjs-tests.ts b/types/pulltorefreshjs/pulltorefreshjs-tests.ts index b971e7a92d..47ca43a2e9 100644 --- a/types/pulltorefreshjs/pulltorefreshjs-tests.ts +++ b/types/pulltorefreshjs/pulltorefreshjs-tests.ts @@ -16,4 +16,4 @@ PullToRefresh.init({ PullToRefresh.init({ mainElement: "body", onRefresh: () => Promise.resolve(), -}); \ No newline at end of file +}); diff --git a/types/pump/index.d.ts b/types/pump/index.d.ts index 7361399a6a..6e8cc7fc8e 100644 --- a/types/pump/index.d.ts +++ b/types/pump/index.d.ts @@ -11,8 +11,8 @@ declare function pump(streams: pump.Stream[], callback?: pump.Callback): pump.St declare function pump(...streams: Array): pump.Stream[]; declare namespace pump { - export type Callback = (err: Error) => any; - export type Stream = NodeJS.ReadableStream | NodeJS.WritableStream; + type Callback = (err: Error) => any; + type Stream = NodeJS.ReadableStream | NodeJS.WritableStream; } export = pump; diff --git a/types/python-shell/python-shell-tests.ts b/types/python-shell/python-shell-tests.ts index 859ea102e2..7529edaac0 100644 --- a/types/python-shell/python-shell-tests.ts +++ b/types/python-shell/python-shell-tests.ts @@ -7,7 +7,7 @@ ps.run('my_script.py', err => { console.log('finished'); }); -var options = { +const options = { mode: 'text', pythonPath: 'path/to/python', pythonOptions: ['-u'], @@ -21,7 +21,7 @@ ps.run('my_script.py', options, (err, results) => { console.log('results: %j', results); }); -var pyshell = new PythonShell('my_script.py'); +const pyshell = new PythonShell('my_script.py'); // sends a message to the Python script via stdin pyshell.send('hello'); @@ -35,4 +35,4 @@ pyshell.on('message', message => { pyshell.end(err => { if (err) throw err; console.log('finished'); -}); \ No newline at end of file +}); diff --git a/types/qlik-visualizationextensions/index.d.ts b/types/qlik-visualizationextensions/index.d.ts index 4a4a635e4f..d4296fca5b 100644 --- a/types/qlik-visualizationextensions/index.d.ts +++ b/types/qlik-visualizationextensions/index.d.ts @@ -654,12 +654,12 @@ declare namespace BackendAPI { interface INxPatch { /** - * Operation to perform. - * One of: - * # Add - * # Remove - * # Replace - */ + * Operation to perform. + * One of: + * # Add + * # Remove + * # Replace + */ qOp: PatchType; /** @@ -1182,7 +1182,7 @@ declare namespace AppAPI { field(field?: string, state?: string): FieldAPI.IQField; /** - * Step forward in list of selections. + * Step forward in list of selections. * @return {Promise} - A promise of a Qlik engine reply. */ forward(): ng.IPromise; @@ -2178,7 +2178,7 @@ declare namespace VisualizationAPI { * # treemap * # extension * @param {array} [cols] - Optional. Column definitions, dimensions and measures. - Each entry can be of the following structures: + * Each entry can be of the following structures: * # String * # NxDimension * # NxMeasure @@ -2481,14 +2481,14 @@ interface IQVAngular { filter(object: { [name: string]: ng.Injectable }): void; /** - * Register a service constructor, which will be invoked with new to create - * the service instance. This is short for registering a service where its - * provider's $get property is a factory function that returns an instance - * instantiated by the injector from the service constructor function. - * @param name The name of the instance. - * @param serviceConstructor An injectable class (constructor function) that will be instantiated. - * @return Returns the constructed singleton of the service class/function. - */ + * Register a service constructor, which will be invoked with new to create + * the service instance. This is short for registering a service where its + * provider's $get property is a factory function that returns an instance + * instantiated by the injector from the service constructor function. + * @param name The name of the instance. + * @param serviceConstructor An injectable class (constructor function) that will be instantiated. + * @return Returns the constructed singleton of the service class/function. + */ service(name: string, serviceConstructor: ng.Injectable): T; service(object: { [name: string]: ng.Injectable }): T; diff --git a/types/qrcode.react/index.d.ts b/types/qrcode.react/index.d.ts index c7a6b85d72..4de6ba60db 100644 --- a/types/qrcode.react/index.d.ts +++ b/types/qrcode.react/index.d.ts @@ -7,7 +7,7 @@ /// declare namespace qrcode { - export interface QRCodeProps { + interface QRCodeProps { value: string; size?: number; bgColor?: string; @@ -15,7 +15,7 @@ declare namespace qrcode { level?: "L"|"M"|"Q"|"H"; } - export type QRCode = React.ComponentClass; + type QRCode = React.ComponentClass; } declare const qrcode: qrcode.QRCode; diff --git a/types/query-string/index.d.ts b/types/query-string/index.d.ts index 4021bb524b..a7ad2763df 100644 --- a/types/query-string/index.d.ts +++ b/types/query-string/index.d.ts @@ -4,36 +4,33 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -declare module "query-string" { - - interface ParseOptions { - arrayFormat?: 'bracket' | 'index' | 'none'; - } - - /** - * Parse a query string into an object. - * Leading ? or # are ignored, so you can pass location.search or location.hash directly. - * @param str - */ - export function parse(str: string, options?: ParseOptions): any; - - interface StringifyOptions { - strict?: boolean; - encode?: boolean; - arrayFormat?: 'bracket' | 'index' | 'none'; - } - - /** - * Stringify an object into a query string, sorting the keys. - * - * @param obj - */ - export function stringify(obj: object, options?: StringifyOptions): string; - - /** - * Extract a query string from a URL that can be passed into .parse(). - * - * @param str - */ - export function extract(str: string): string; +export interface ParseOptions { + arrayFormat?: 'bracket' | 'index' | 'none'; } + +/** + * Parse a query string into an object. + * Leading ? or # are ignored, so you can pass location.search or location.hash directly. + * @param str + */ +export function parse(str: string, options?: ParseOptions): any; + +export interface StringifyOptions { + strict?: boolean; + encode?: boolean; + arrayFormat?: 'bracket' | 'index' | 'none'; +} + +/** + * Stringify an object into a query string, sorting the keys. + * + * @param obj + */ +export function stringify(obj: object, options?: StringifyOptions): string; + +/** + * Extract a query string from a URL that can be passed into .parse(). + * + * @param str + */ +export function extract(str: string): string; diff --git a/types/range-parser/index.d.ts b/types/range-parser/index.d.ts index e90f448e11..5912777ec0 100644 --- a/types/range-parser/index.d.ts +++ b/types/range-parser/index.d.ts @@ -6,17 +6,17 @@ declare function RangeParser(size: number, str: string, options?: RangeParser.Options): RangeParser.Result | RangeParser.Ranges; declare namespace RangeParser { - export interface Ranges extends Array { + interface Ranges extends Array { type: string; } - export interface Range { + interface Range { start: number; end: number; } - export interface Options { + interface Options { combine?: boolean; } - export const enum Result { + const enum Result { invaild = -2, unsatisifiable = -1, } diff --git a/types/raven/index.d.ts b/types/raven/index.d.ts index 2d9da8ccaf..359ead4608 100644 --- a/types/raven/index.d.ts +++ b/types/raven/index.d.ts @@ -8,26 +8,25 @@ import { IncomingMessage, ServerResponse } from 'http'; import { EventEmitter } from 'events'; +export const version: string; +export function config(dsn: string | false, options?: ConstructorOptions): Client; +export function wrap(func: () => void, onErr?: () => void): () => void; +export function wrap(options: any, func: () => void, onErr?: () => void): () => void; +export function interceptErr(ctx: any): Client; +export function setContext(ctx: any): Client; +export function captureException(e: Error, cb?: CaptureCallback): Client; +export function captureException(e: Error, options?: CaptureOptions, cb?: CaptureCallback): Client; +export function mergeContext(ctx: any): Client; +export function getContext(): any; +export function errorHandler(): (e: Error, req: IncomingMessage, res: ServerResponse, next: () => void) => void; +export function context(ctx: any, func: () => void, onErr?: () => void): Client; +export function context(func: () => void, onErr?: () => void): Client; +export function captureBreadcrumb(breadcrumb: any): void; +export function disableConsoleAlerts(): void; +export function consoleAlert(msg: string): void; +export function parseDSN(dsn: string | false): parsedDSN; -declare const version: string; -declare function config(dsn: string | false, options?: ConstructorOptions): Client; -declare function wrap(func: () => void, onErr?: () => void): () => void; -declare function wrap(options: any, func: () => void, onErr?: () => void): () => void; -declare function interceptErr(ctx: any): Client; -declare function setContext(ctx: any): Client; -declare function captureException(e: Error, cb?: CaptureCallback): Client; -declare function captureException(e: Error, options?: CaptureOptions, cb?: CaptureCallback): Client; -declare function mergeContext(ctx: any): Client; -declare function getContext(): any; -declare function errorHandler(): (e: Error, req: IncomingMessage, res: ServerResponse, next: () => void) => void; -declare function context(ctx: any, func: () => void, onErr?: () => void): Client; -declare function context(func: () => void, onErr?: () => void): Client; -declare function captureBreadcrumb(breadcrumb: any): void; -declare function disableConsoleAlerts(): void; -declare function consoleAlert(msg: string): void; -declare function parseDSN(dsn: string | false): parsedDSN; - -declare class Client extends EventEmitter { +export class Client extends EventEmitter { constructor(options: ConstructorOptions); constructor(dsn: string, options?: ConstructorOptions); config(dsn: string, options?: ConstructorOptions): Client; @@ -48,7 +47,7 @@ declare class Client extends EventEmitter { process(eventId: string, kwargs: any, cb?: () => void): void; } -declare interface ConstructorOptions { +export interface ConstructorOptions { name?: string; logger?: string; release?: string; @@ -56,17 +55,17 @@ declare interface ConstructorOptions { tags?: { string: string }; extra?: { string: any }; dataCallback?: DataCallback; - transport?: () => void; + transport?(): void; captureUnhandledRejections?: boolean; autoBreadcrumbs?: boolean | any; } -declare interface UserData { +export interface UserData { id: string; handle?: string; } -declare interface parsedDSN { +export interface parsedDSN { protocol: string; public_key: string; private_key: string; @@ -76,19 +75,13 @@ declare interface parsedDSN { port: number; } -declare interface CaptureCallback { - (err: { string: any }, eventId: any): void; -} +export type CaptureCallback = (err: { string: any }, eventId: any) => void; -declare interface DataCallback { - (data: { string: any }): void; -} +export type DataCallback = (data: { string: any }) => void; -declare interface TransportCallback { - (options: { string: any }): void; -} +export type TransportCallback = (options: { string: any }) => void; -declare interface CaptureOptions { +export interface CaptureOptions { tags?: { string: string }; extra?: { string: any }; fingerprint?: string; diff --git a/types/raven/raven-tests.ts b/types/raven/raven-tests.ts index ae493c0dd8..d419b32d12 100644 --- a/types/raven/raven-tests.ts +++ b/types/raven/raven-tests.ts @@ -16,7 +16,7 @@ new Raven.Client(dsn); try { throw new Error(); } catch (e) { - var eventId = Raven.captureException(e, (sendErr, eventId) => { }); + const eventId = Raven.captureException(e, (sendErr, eventId) => { }); } Raven.setContext({}); @@ -24,6 +24,5 @@ Raven.mergeContext({}); Raven.context(() => { Raven.captureBreadcrumb({}); }); -var doIt = () => { } -setTimeout(Raven.wrap(doIt), 1000) -Raven.parseDSN('https://8769c40cf49c4cc58b51fa45d8e2d166:296768aa91084e17b5ac02d3ad5bc7e7@app.getsentry.com/269') +setTimeout(Raven.wrap(() => {}), 1000); +Raven.parseDSN('https://8769c40cf49c4cc58b51fa45d8e2d166:296768aa91084e17b5ac02d3ad5bc7e7@app.getsentry.com/269'); diff --git a/types/raw-body/index.d.ts b/types/raw-body/index.d.ts index bb074bac8e..7a10fa84b3 100644 --- a/types/raw-body/index.d.ts +++ b/types/raw-body/index.d.ts @@ -8,9 +8,9 @@ import { Readable } from "stream"; declare namespace getRawBody { - export type Encoding = string | true; + type Encoding = string | true; - export interface Options { + interface Options { /** * The length of the stream. If the contents of the stream do not add up to this length, an 400 error code is returned. */ @@ -30,7 +30,7 @@ declare namespace getRawBody { encoding?: Encoding | null; } - export interface RawBodyError extends Error { + interface RawBodyError extends Error { /** * The limit in bytes. */ diff --git a/types/rc-slider/index.d.ts b/types/rc-slider/index.d.ts index 37ce19ac59..1077faf3c9 100644 --- a/types/rc-slider/index.d.ts +++ b/types/rc-slider/index.d.ts @@ -28,15 +28,15 @@ declare namespace RcSliderClass { */ max?: number; /** - * Marks on the slider. The key determines the position, and the value determines what will show. - * If you want to set the style of a specific mark point, the value should be an object which contains style and label properties. - * @default '{}' | {number: { style, label }} - */ + * Marks on the slider. The key determines the position, and the value determines what will show. + * If you want to set the style of a specific mark point, the value should be an object which contains style and label properties. + * @default '{}' | {number: { style, label }} + */ marks?: Marks; /** - * Value to be added or subtracted on each step the slider makes. Must be greater than zero, and max - min should be evenly divisible by the step value. - * @default 1 - */ + * Value to be added or subtracted on each step the slider makes. Must be greater than zero, and max - min should be evenly divisible by the step value. + * @default 1 + */ step?: number; /** * If vertical is true, the slider will be vertical. @@ -65,15 +65,15 @@ declare namespace RcSliderClass { /** * onBeforeChange will be triggered when ontouchstart or onmousedown is triggered. */ - onBeforeChange?: (value: any) => any | undefined; + onBeforeChange?(value: any): any | undefined; /** * onChange will be triggered while the value of Slider changing. */ - onChange?: (value: any) => any | undefined; + onChange?(value: any): any | undefined; /** * onAfterChange will be triggered when ontouchend or onmouseup is triggered. */ - onAfterChange?: (value: any) => any | undefined; + onAfterChange?(value: any): any | undefined; /** * @deprecated in version ^6.0.0. Use rc-tooltip diff --git a/types/rc-tree/index.d.ts b/types/rc-tree/index.d.ts index 54968e6884..a485371062 100644 --- a/types/rc-tree/index.d.ts +++ b/types/rc-tree/index.d.ts @@ -58,7 +58,6 @@ export interface SelectData { event: "select"; } - export interface TreeProps extends Props { /** * additional css class of root dom node @@ -129,23 +128,23 @@ export interface TreeProps extends Props { /** * fire on treeNode expand or not */ - onExpand?: (expandedKeys: string[], e: ExpandData) => void; + onExpand?(expandedKeys: string[], e: ExpandData): void; /** * click the treeNode/checkbox to fire */ - onCheck?: (checkedKeys: string[], e: CheckData) => void; + onCheck?(checkedKeys: string[], e: CheckData): void; /** * click the treeNode to fire */ - onSelect?: (selectedKeys: string[], e: SelectData) => void; + onSelect?(selectedKeys: string[], e: SelectData): void; /** * filter some treeNodes as you need. */ - filterTreeNode?: (node: TreeNode) => boolean; + filterTreeNode?(node: TreeNode): boolean; /** * load data asynchronously */ - loadData?: (node: TreeNode) => Promise; + loadData?(node: TreeNode): Promise; /** * whether can drag treeNode. */ diff --git a/types/rc-tree/rc-tree-tests.tsx b/types/rc-tree/rc-tree-tests.tsx index 857054aa13..c57866284f 100644 --- a/types/rc-tree/rc-tree-tests.tsx +++ b/types/rc-tree/rc-tree-tests.tsx @@ -1,7 +1,6 @@ import * as React from 'react'; import Tree, { TreeNode, SelectData, CheckData } from 'rc-tree'; - interface Props { keys: string[]; } @@ -30,7 +29,6 @@ export class Demo extends React.Component { keys: ['0-0-0-0'], }; - getInitialState() { } diff --git a/types/react-autosuggest/index.d.ts b/types/react-autosuggest/index.d.ts index 7199fefcdb..165262eb39 100644 --- a/types/react-autosuggest/index.d.ts +++ b/types/react-autosuggest/index.d.ts @@ -4,7 +4,6 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 - import * as React from 'react'; declare class Autosuggest extends React.Component {} @@ -32,11 +31,11 @@ declare namespace Autosuggest { interface InputProps extends React.HTMLAttributes { value: string; - onChange: (event: React.FormEvent, params?: ChangeEvent) => void; - onBlur?: (event: React.FormEvent, params?: BlurEvent) => void; + onChange(event: React.FormEvent, params?: ChangeEvent): void; + onBlur?(event: React.FormEvent, params?: BlurEvent): void; } - export interface SuggestionSelectedEventData { + interface SuggestionSelectedEventData { method: 'click' | 'enter'; sectionIndex: number | null; suggestion: TSuggestion; @@ -57,23 +56,22 @@ declare namespace Autosuggest { interface AutosuggestProps extends React.Props { suggestions: any[]; - onSuggestionsFetchRequested: (request: SuggestionsFetchRequest) => void; - onSuggestionsClearRequested?: () => void; - getSuggestionValue: (suggestion: any) => any; - renderSuggestion: (suggestion: any, inputValues: InputValues) => JSX.Element; + onSuggestionsFetchRequested(request: SuggestionsFetchRequest): void; + onSuggestionsClearRequested?(): void; + getSuggestionValue(suggestion: any): any; + renderSuggestion(suggestion: any, inputValues: InputValues): JSX.Element; inputProps: InputProps; - onSuggestionSelected?: (event: React.FormEvent, data: SuggestionSelectedEventData) => void; - shouldRenderSuggestions?: (value: string) => boolean; + onSuggestionSelected?(event: React.FormEvent, data: SuggestionSelectedEventData): void; + shouldRenderSuggestions?(value: string): boolean; alwaysRenderSuggestions?: boolean; focusFirstSuggestion?: boolean; focusInputOnSuggestionClick?: boolean; multiSection?: boolean; - renderSectionTitle?: (section: any, inputValues: InputValues) => JSX.Element; - getSectionSuggestions?: (section: any) => any[]; - renderInputComponent?: () => JSX.Element; - renderSuggestionsContainer?: (children: any) => JSX.Element; + renderSectionTitle?(section: any, inputValues: InputValues): JSX.Element; + getSectionSuggestions?(section: any): any[]; + renderInputComponent?(): JSX.Element; + renderSuggestionsContainer?(children: any): JSX.Element; theme?: Theme; id?: string; } - } diff --git a/types/react-body-classname/index.d.ts b/types/react-body-classname/index.d.ts index e20bffdc73..b7f0856df9 100644 --- a/types/react-body-classname/index.d.ts +++ b/types/react-body-classname/index.d.ts @@ -13,4 +13,4 @@ declare class BodyClassName extends React.Component<{ className: string }, any> static displayName: string; static peek(): any; static rewind(): any; -} \ No newline at end of file +} diff --git a/types/react-body-classname/react-body-classname-tests.tsx b/types/react-body-classname/react-body-classname-tests.tsx index 7fb971fe44..019105bee6 100644 --- a/types/react-body-classname/react-body-classname-tests.tsx +++ b/types/react-body-classname/react-body-classname-tests.tsx @@ -23,4 +23,4 @@ class App { // Becuase we nested the component, our body will now have 'app home' // as the class name } -} \ No newline at end of file +} diff --git a/types/react-bootstrap-date-picker/index.d.ts b/types/react-bootstrap-date-picker/index.d.ts index f905dc77a7..28a5b0c72b 100644 --- a/types/react-bootstrap-date-picker/index.d.ts +++ b/types/react-bootstrap-date-picker/index.d.ts @@ -14,10 +14,9 @@ declare const DatePicker: DatePicker; type DatePicker = ComponentClass; declare namespace DatePicker { + type ChangeCallback = (value: string, formattedValue: string) => void; - export type ChangeCallback = (value: string, formattedValue: string) => void; - - export interface DatePickerProps { + interface DatePickerProps { value?: string; defaultValue?: string; style?: any; @@ -30,7 +29,7 @@ declare namespace DatePicker { dateFormat?: string; clearButtonElement?: ReactNode; showClearButton?: boolean; - onClear?: () => void; + onClear?(): void; previousButtonElement?: ReactNode; nextButtonElement?: ReactNode; cellPadding?: string; @@ -43,5 +42,4 @@ declare namespace DatePicker { todayButtonLabel?: string; customControl?: StatelessComponent | ComponentClass; } - } diff --git a/types/react-copy-to-clipboard/index.d.ts b/types/react-copy-to-clipboard/index.d.ts index e4a0948962..67b70b0ad1 100644 --- a/types/react-copy-to-clipboard/index.d.ts +++ b/types/react-copy-to-clipboard/index.d.ts @@ -18,7 +18,7 @@ declare namespace CopyToClipboard { interface Props { text: string; - onCopy?: (a: string) => void; + onCopy?(a: string): void; options?: Options; } } diff --git a/types/react-day-picker/react-day-picker-tests.tsx b/types/react-day-picker/react-day-picker-tests.tsx index 52da9e9735..1733b713dd 100644 --- a/types/react-day-picker/react-day-picker-tests.tsx +++ b/types/react-day-picker/react-day-picker-tests.tsx @@ -47,6 +47,6 @@ class CaptionElement extends React.Component { { localeUtils.formatMonthTitle(date, locale) } ); - }; + } } }/>; diff --git a/types/react-dnd-html5-backend/react-dnd-html5-backend-tests.ts b/types/react-dnd-html5-backend/react-dnd-html5-backend-tests.ts index 68703d062d..198909b7e9 100644 --- a/types/react-dnd-html5-backend/react-dnd-html5-backend-tests.ts +++ b/types/react-dnd-html5-backend/react-dnd-html5-backend-tests.ts @@ -4,7 +4,7 @@ import React = require("react"); import ReactDnd = require("react-dnd"); -var r = React.DOM; +const r = React.DOM; import DragSource = ReactDnd.DragSource; import DropTarget = ReactDnd.DropTarget; @@ -15,8 +15,8 @@ import HTML5Backend, { getEmptyImage } from 'react-dnd-html5-backend'; // ---------------------------------------------------------------------- namespace Game { - var knightPosition = [0, 0]; - var observer: any = null; + let knightPosition = [0, 0]; + let observer: any = null; function emitChange() { observer(knightPosition); @@ -47,7 +47,7 @@ namespace Game { } } -var ItemTypes = { +const ItemTypes = { KNIGHT: "knight" }; @@ -61,7 +61,7 @@ namespace Knight { isDragging: boolean; } - var knightSource: ReactDnd.DragSourceSpec = { + const knightSource: ReactDnd.DragSourceSpec = { beginDrag: (props) => { return {}; } @@ -81,7 +81,7 @@ namespace Knight { static create = React.createFactory(Knight); componentDidMount() { - var img = getEmptyImage(); + const img = getEmptyImage(); img.onload = () => this.props.connectDragPreview(img); } @@ -99,8 +99,8 @@ namespace Knight { } } - export var DndKnight = DragSource(ItemTypes.KNIGHT, knightSource, knightCollect)(Knight); - export var create = React.createFactory(DndKnight); + export const DndKnight = DragSource(ItemTypes.KNIGHT, knightSource, knightCollect)(Knight); + export const create = React.createFactory(DndKnight); } // Square Component @@ -113,7 +113,7 @@ namespace Square { export class Square extends React.Component { render() { - var fill = this.props.black ? 'black' : 'white'; + const fill = this.props.black ? 'black' : 'white'; return r.div({ style: { backgroundColor: fill @@ -122,7 +122,7 @@ namespace Square { } } - export var create = React.createFactory(Square); + export const create = React.createFactory(Square); } // BoardSquare Component @@ -137,7 +137,7 @@ namespace BoardSquare { canDrop?: boolean; } - var boardSquareTarget: ReactDnd.DropTargetSpec = { + const boardSquareTarget: ReactDnd.DropTargetSpec = { canDrop: (props) => Game.canMoveKnight(props.x, props.y), drop: (props) => Game.moveKnight(props.x, props.y) }; @@ -169,9 +169,9 @@ namespace BoardSquare { } render() { - var black = (this.props.x + this.props.y) % 2 === 1; - var isOver = this.props.isOver; - var canDrop = this.props.canDrop; + const black = (this.props.x + this.props.y) % 2 === 1; + const isOver = this.props.isOver; + const canDrop = this.props.canDrop; return this.props.connectDropTarget( r.div({ @@ -191,8 +191,8 @@ namespace BoardSquare { } } - export var DndBoardSquare = DropTarget(ItemTypes.KNIGHT, boardSquareTarget, boardSquareCollect)(BoardSquare); - export var create = React.createFactory(DndBoardSquare); + export const DndBoardSquare = DropTarget(ItemTypes.KNIGHT, boardSquareTarget, boardSquareCollect)(BoardSquare); + export const create = React.createFactory(DndBoardSquare); } // Custom Drag Layer Component @@ -216,9 +216,9 @@ namespace CustomDragLayer { } } - export var dragLayer = DragLayer(dragLayerCollect)(CustomDragLayer); + export const dragLayer = DragLayer(dragLayerCollect)(CustomDragLayer); - export var create = React.createFactory(dragLayer); + export const create = React.createFactory(dragLayer); } // Board Component @@ -231,16 +231,16 @@ namespace Board { export class Board extends React.Component { private _renderPiece = (x: number, y: number) => { - var knightX = this.props.knightPosition[0]; - var knightY = this.props.knightPosition[1]; + const knightX = this.props.knightPosition[0]; + const knightY = this.props.knightPosition[1]; return x === knightX && y === knightY ? Knight.create() : null; } private _renderSquare = (i: number) => { - var x = i % 8; - var y = Math.floor(i / 8); + const x = i % 8; + const y = Math.floor(i / 8); return r.div({ key: i, @@ -252,7 +252,7 @@ namespace Board { } render() { - var squares: Array> = []; + const squares: Array> = []; for (let i = 0; i < 64; i++) { squares.push(this._renderSquare(i)); } @@ -274,7 +274,7 @@ namespace Board { } } - export var createWithHTMLBackend = React.createFactory(DragDropContext(HTML5Backend)(Board)); + export const createWithHTMLBackend = React.createFactory(DragDropContext(HTML5Backend)(Board)); } // Render the Board Component diff --git a/types/react-event-listener/index.d.ts b/types/react-event-listener/index.d.ts index c6d05b313b..906e3711e0 100644 --- a/types/react-event-listener/index.d.ts +++ b/types/react-event-listener/index.d.ts @@ -21,188 +21,188 @@ export function withOptions(handler: (ev: T) => any, options: EventOptions): export interface EventListenerProps { // Global events - onPointerCancel?: (ev: PointerEvent) => any; - onPointerCancelCapture?: (ev: PointerEvent) => any; - onPointerDown?: (ev: PointerEvent) => any; - onPointerDownCapture?: (ev: PointerEvent) => any; - onPointerEnter?: (ev: PointerEvent) => any; - onPointerEnterCapture?: (ev: PointerEvent) => any; - onPointerLeave?: (ev: PointerEvent) => any; - onPointerLeaveCapture?: (ev: PointerEvent) => any; - onPointerMove?: (ev: PointerEvent) => any; - onPointerMoveCapture?: (ev: PointerEvent) => any; - onPointerOut?: (ev: PointerEvent) => any; - onPointerOutCapture?: (ev: PointerEvent) => any; - onPointerOver?: (ev: PointerEvent) => any; - onPointerOverCapture?: (ev: PointerEvent) => any; - onPointerUp?: (ev: PointerEvent) => any; - onPointerUpCapture?: (ev: PointerEvent) => any; - onWheel?: (ev: WheelEvent) => any; - onWheelCapture?: (ev: WheelEvent) => any; - onAbort?: (ev: Event) => any; - onAbortCapture?: (ev: Event) => any; - onAfterPrint?: (ev: Event) => any; - onAfterPrintCapture?: (ev: Event) => any; - onBeforePrint?: (ev: Event) => any; - onBeforePrintCapture?: (ev: Event) => any; - onBeforeUnload?: (ev: BeforeUnloadEvent) => any; - onBeforeUnloadCapture?: (ev: BeforeUnloadEvent) => any; - onBlur?: (ev: FocusEvent) => any; - onBlurCapture?: (ev: FocusEvent) => any; - onCanPlay?: (ev: Event) => any; - onCanPlayCapture?: (ev: Event) => any; - onCanPlayThrough?: (ev: Event) => any; - onCanPlayThroughCapture?: (ev: Event) => any; - onChange?: (ev: Event) => any; - onChangeCapture?: (ev: Event) => any; - onClick?: (ev: MouseEvent) => any; - onClickCapture?: (ev: MouseEvent) => any; - onCompassNeedsCalibration?: (ev: Event) => any; - onCompassNeedsCalibrationCapture?: (ev: Event) => any; - onContextMenu?: (ev: PointerEvent) => any; - onContextMenuCapture?: (ev: PointerEvent) => any; - onDblClick?: (ev: MouseEvent) => any; - onDblClickCapture?: (ev: MouseEvent) => any; - onDeviceMotion?: (ev: DeviceMotionEvent) => any; - onDeviceMotionCapture?: (ev: DeviceMotionEvent) => any; - onDeviceOrientation?: (ev: DeviceOrientationEvent) => any; - onDeviceOrientationCapture?: (ev: DeviceOrientationEvent) => any; - onDrag?: (ev: DragEvent) => any; - onDragCapture?: (ev: DragEvent) => any; - onDragEnd?: (ev: DragEvent) => any; - onDragEndCapture?: (ev: DragEvent) => any; - onDragEnter?: (ev: DragEvent) => any; - onDragEnterCapture?: (ev: DragEvent) => any; - onDragLeave?: (ev: DragEvent) => any; - onDragLeaveCapture?: (ev: DragEvent) => any; - onDragOver?: (ev: DragEvent) => any; - onDragOverCapture?: (ev: DragEvent) => any; - onDragStart?: (ev: DragEvent) => any; - onDragStartCapture?: (ev: DragEvent) => any; - onDrop?: (ev: DragEvent) => any; - onDropCapture?: (ev: DragEvent) => any; - onDurationChange?: (ev: Event) => any; - onDurationChangeCapture?: (ev: Event) => any; - onEmptied?: (ev: Event) => any; - onEmptiedCapture?: (ev: Event) => any; - onEnded?: (ev: Event) => any; - onEndedCapture?: (ev: Event) => any; + onPointerCancel?(ev: PointerEvent): any; + onPointerCancelCapture?(ev: PointerEvent): any; + onPointerDown?(ev: PointerEvent): any; + onPointerDownCapture?(ev: PointerEvent): any; + onPointerEnter?(ev: PointerEvent): any; + onPointerEnterCapture?(ev: PointerEvent): any; + onPointerLeave?(ev: PointerEvent): any; + onPointerLeaveCapture?(ev: PointerEvent): any; + onPointerMove?(ev: PointerEvent): any; + onPointerMoveCapture?(ev: PointerEvent): any; + onPointerOut?(ev: PointerEvent): any; + onPointerOutCapture?(ev: PointerEvent): any; + onPointerOver?(ev: PointerEvent): any; + onPointerOverCapture?(ev: PointerEvent): any; + onPointerUp?(ev: PointerEvent): any; + onPointerUpCapture?(ev: PointerEvent): any; + onWheel?(ev: WheelEvent): any; + onWheelCapture?(ev: WheelEvent): any; + onAbort?(ev: Event): any; + onAbortCapture?(ev: Event): any; + onAfterPrint?(ev: Event): any; + onAfterPrintCapture?(ev: Event): any; + onBeforePrint?(ev: Event): any; + onBeforePrintCapture?(ev: Event): any; + onBeforeUnload?(ev: BeforeUnloadEvent): any; + onBeforeUnloadCapture?(ev: BeforeUnloadEvent): any; + onBlur?(ev: FocusEvent): any; + onBlurCapture?(ev: FocusEvent): any; + onCanPlay?(ev: Event): any; + onCanPlayCapture?(ev: Event): any; + onCanPlayThrough?(ev: Event): any; + onCanPlayThroughCapture?(ev: Event): any; + onChange?(ev: Event): any; + onChangeCapture?(ev: Event): any; + onClick?(ev: MouseEvent): any; + onClickCapture?(ev: MouseEvent): any; + onCompassNeedsCalibration?(ev: Event): any; + onCompassNeedsCalibrationCapture?(ev: Event): any; + onContextMenu?(ev: PointerEvent): any; + onContextMenuCapture?(ev: PointerEvent): any; + onDblClick?(ev: MouseEvent): any; + onDblClickCapture?(ev: MouseEvent): any; + onDeviceMotion?(ev: DeviceMotionEvent): any; + onDeviceMotionCapture?(ev: DeviceMotionEvent): any; + onDeviceOrientation?(ev: DeviceOrientationEvent): any; + onDeviceOrientationCapture?(ev: DeviceOrientationEvent): any; + onDrag?(ev: DragEvent): any; + onDragCapture?(ev: DragEvent): any; + onDragEnd?(ev: DragEvent): any; + onDragEndCapture?(ev: DragEvent): any; + onDragEnter?(ev: DragEvent): any; + onDragEnterCapture?(ev: DragEvent): any; + onDragLeave?(ev: DragEvent): any; + onDragLeaveCapture?(ev: DragEvent): any; + onDragOver?(ev: DragEvent): any; + onDragOverCapture?(ev: DragEvent): any; + onDragStart?(ev: DragEvent): any; + onDragStartCapture?(ev: DragEvent): any; + onDrop?(ev: DragEvent): any; + onDropCapture?(ev: DragEvent): any; + onDurationChange?(ev: Event): any; + onDurationChangeCapture?(ev: Event): any; + onEmptied?(ev: Event): any; + onEmptiedCapture?(ev: Event): any; + onEnded?(ev: Event): any; + onEndedCapture?(ev: Event): any; onError?: ErrorEventHandler; onErrorCapture?: ErrorEventHandler; - onFocus?: (ev: FocusEvent) => any; - onFocusCapture?: (ev: FocusEvent) => any; - onHashChange?: (ev: HashChangeEvent) => any; - onHashChangeCapture?: (ev: HashChangeEvent) => any; - onInput?: (ev: Event) => any; - onInputCapture?: (ev: Event) => any; - onKeyDown?: (ev: KeyboardEvent) => any; - onKeyDownCapture?: (ev: KeyboardEvent) => any; - onKeyPress?: (ev: KeyboardEvent) => any; - onKeyPressCapture?: (ev: KeyboardEvent) => any; - onKeyUp?: (ev: KeyboardEvent) => any; - onKeyUpCapture?: (ev: KeyboardEvent) => any; - onLoad?: (ev: Event) => any; - onLoadCapture?: (ev: Event) => any; - onLoadedData?: (ev: Event) => any; - onLoadedDataCapture?: (ev: Event) => any; - onLoadedMetadata?: (ev: Event) => any; - onLoadedMetadataCapture?: (ev: Event) => any; - onLoadStart?: (ev: Event) => any; - onLoadStartCapture?: (ev: Event) => any; - onMessage?: (ev: MessageEvent) => any; - onMessageCapture?: (ev: MessageEvent) => any; - onMouseDown?: (ev: MouseEvent) => any; - onMouseDownCapture?: (ev: MouseEvent) => any; - onMouseEnter?: (ev: MouseEvent) => any; - onMouseEnterCapture?: (ev: MouseEvent) => any; - onMouseLeave?: (ev: MouseEvent) => any; - onMouseLeaveCapture?: (ev: MouseEvent) => any; - onMouseMove?: (ev: MouseEvent) => any; - onMouseMoveCapture?: (ev: MouseEvent) => any; - onMouseOut?: (ev: MouseEvent) => any; - onMouseOutCapture?: (ev: MouseEvent) => any; - onMouseOver?: (ev: MouseEvent) => any; - onMouseOverCapture?: (ev: MouseEvent) => any; - onMouseUp?: (ev: MouseEvent) => any; - onMouseUpCapture?: (ev: MouseEvent) => any; - onMouseWheel?: (ev: MouseWheelEvent) => any; - onMouseWheelCapture?: (ev: MouseWheelEvent) => any; - onMsGestureChange?: (ev: MSGestureEvent) => any; - onMsGestureChangeCapture?: (ev: MSGestureEvent) => any; - onMsGestureDoubleTap?: (ev: MSGestureEvent) => any; - onMsGestureDoubleTapCapture?: (ev: MSGestureEvent) => any; - onMsGestureEnd?: (ev: MSGestureEvent) => any; - onMsGestureEndCapture?: (ev: MSGestureEvent) => any; - onMsGestureHold?: (ev: MSGestureEvent) => any; - onMsGestureHoldCapture?: (ev: MSGestureEvent) => any; - onMsGestureStart?: (ev: MSGestureEvent) => any; - onMsGestureStartCapture?: (ev: MSGestureEvent) => any; - onMsGestureTap?: (ev: MSGestureEvent) => any; - onMsGestureTapCapture?: (ev: MSGestureEvent) => any; - onMsInertiaStart?: (ev: MSGestureEvent) => any; - onMsInertiaStartCapture?: (ev: MSGestureEvent) => any; - onMsPointerCancel?: (ev: MSPointerEvent) => any; - onMsPointerCancelCapture?: (ev: MSPointerEvent) => any; - onMsPointerDown?: (ev: MSPointerEvent) => any; - onMsPointerDownCapture?: (ev: MSPointerEvent) => any; - onMsPointerEnter?: (ev: MSPointerEvent) => any; - onMsPointerEnterCapture?: (ev: MSPointerEvent) => any; - onMsPointerLeave?: (ev: MSPointerEvent) => any; - onMsPointerLeaveCapture?: (ev: MSPointerEvent) => any; - onMsPointerMove?: (ev: MSPointerEvent) => any; - onMsPointerMoveCapture?: (ev: MSPointerEvent) => any; - onMsPointerOut?: (ev: MSPointerEvent) => any; - onMsPointerOutCapture?: (ev: MSPointerEvent) => any; - onMsPointerOver?: (ev: MSPointerEvent) => any; - onMsPointerOverCapture?: (ev: MSPointerEvent) => any; - oNmsPointerUp?: (ev: MSPointerEvent) => any; - oNmsPointerUpCapture?: (ev: MSPointerEvent) => any; - onOffline?: (ev: Event) => any; - onOfflineCapture?: (ev: Event) => any; - onOnline?: (ev: Event) => any; - onOnlineCapture?: (ev: Event) => any; - onOrientationChange?: (ev: Event) => any; - onOrientationChangeCapture?: (ev: Event) => any; - onPageHide?: (ev: PageTransitionEvent) => any; - onPageHideCapture?: (ev: PageTransitionEvent) => any; - onPageShow?: (ev: PageTransitionEvent) => any; - onPageShowCapture?: (ev: PageTransitionEvent) => any; - onPause?: (ev: Event) => any; - onPauseCapture?: (ev: Event) => any; - onPlay?: (ev: Event) => any; - onPlayCapture?: (ev: Event) => any; - onPlaying?: (ev: Event) => any; - onPlayingCapture?: (ev: Event) => any; - onPopState?: (ev: PopStateEvent) => any; - onPopStateCapture?: (ev: PopStateEvent) => any; - onProgress?: (ev: ProgressEvent) => any; - onProgressCapture?: (ev: ProgressEvent) => any; - onRateChange?: (ev: Event) => any; - onRateChangeCapture?: (ev: Event) => any; - onReadyStateChange?: (ev: ProgressEvent) => any; - onReadyStateChangeCapture?: (ev: ProgressEvent) => any; - onReset?: (ev: Event) => any; - onResetCapture?: (ev: Event) => any; - onResize?: (ev: UIEvent) => any; - onResizeCapture?: (ev: UIEvent) => any; - onScroll?: (ev: UIEvent) => any; - onScrollCapture?: (ev: UIEvent) => any; - onSeeked?: (ev: Event) => any; - onSeekedCapture?: (ev: Event) => any; - onSeeking?: (ev: Event) => any; - onSeekingCapture?: (ev: Event) => any; - onSelect?: (ev: UIEvent) => any; - onSelectCapture?: (ev: UIEvent) => any; - onStalled?: (ev: Event) => any; - onStalledCapture?: (ev: Event) => any; - onStorage?: (ev: StorageEvent) => any; - onStorageCapture?: (ev: StorageEvent) => any; - onSubmit?: (ev: Event) => any; - onSubmitCapture?: (ev: Event) => any; - onSuspend?: (ev: Event) => any; - onSuspendCapture?: (ev: Event) => any; - onTimeUpdate?: (ev: Event) => any; - onTimeUpdateCapture?: (ev: Event) => any; + onFocus?(ev: FocusEvent): any; + onFocusCapture?(ev: FocusEvent): any; + onHashChange?(ev: HashChangeEvent): any; + onHashChangeCapture?(ev: HashChangeEvent): any; + onInput?(ev: Event): any; + onInputCapture?(ev: Event): any; + onKeyDown?(ev: KeyboardEvent): any; + onKeyDownCapture?(ev: KeyboardEvent): any; + onKeyPress?(ev: KeyboardEvent): any; + onKeyPressCapture?(ev: KeyboardEvent): any; + onKeyUp?(ev: KeyboardEvent): any; + onKeyUpCapture?(ev: KeyboardEvent): any; + onLoad?(ev: Event): any; + onLoadCapture?(ev: Event): any; + onLoadedData?(ev: Event): any; + onLoadedDataCapture?(ev: Event): any; + onLoadedMetadata?(ev: Event): any; + onLoadedMetadataCapture?(ev: Event): any; + onLoadStart?(ev: Event): any; + onLoadStartCapture?(ev: Event): any; + onMessage?(ev: MessageEvent): any; + onMessageCapture?(ev: MessageEvent): any; + onMouseDown?(ev: MouseEvent): any; + onMouseDownCapture?(ev: MouseEvent): any; + onMouseEnter?(ev: MouseEvent): any; + onMouseEnterCapture?(ev: MouseEvent): any; + onMouseLeave?(ev: MouseEvent): any; + onMouseLeaveCapture?(ev: MouseEvent): any; + onMouseMove?(ev: MouseEvent): any; + onMouseMoveCapture?(ev: MouseEvent): any; + onMouseOut?(ev: MouseEvent): any; + onMouseOutCapture?(ev: MouseEvent): any; + onMouseOver?(ev: MouseEvent): any; + onMouseOverCapture?(ev: MouseEvent): any; + onMouseUp?(ev: MouseEvent): any; + onMouseUpCapture?(ev: MouseEvent): any; + onMouseWheel?(ev: MouseWheelEvent): any; + onMouseWheelCapture?(ev: MouseWheelEvent): any; + onMsGestureChange?(ev: MSGestureEvent): any; + onMsGestureChangeCapture?(ev: MSGestureEvent): any; + onMsGestureDoubleTap?(ev: MSGestureEvent): any; + onMsGestureDoubleTapCapture?(ev: MSGestureEvent): any; + onMsGestureEnd?(ev: MSGestureEvent): any; + onMsGestureEndCapture?(ev: MSGestureEvent): any; + onMsGestureHold?(ev: MSGestureEvent): any; + onMsGestureHoldCapture?(ev: MSGestureEvent): any; + onMsGestureStart?(ev: MSGestureEvent): any; + onMsGestureStartCapture?(ev: MSGestureEvent): any; + onMsGestureTap?(ev: MSGestureEvent): any; + onMsGestureTapCapture?(ev: MSGestureEvent): any; + onMsInertiaStart?(ev: MSGestureEvent): any; + onMsInertiaStartCapture?(ev: MSGestureEvent): any; + onMsPointerCancel?(ev: MSPointerEvent): any; + onMsPointerCancelCapture?(ev: MSPointerEvent): any; + onMsPointerDown?(ev: MSPointerEvent): any; + onMsPointerDownCapture?(ev: MSPointerEvent): any; + onMsPointerEnter?(ev: MSPointerEvent): any; + onMsPointerEnterCapture?(ev: MSPointerEvent): any; + onMsPointerLeave?(ev: MSPointerEvent): any; + onMsPointerLeaveCapture?(ev: MSPointerEvent): any; + onMsPointerMove?(ev: MSPointerEvent): any; + onMsPointerMoveCapture?(ev: MSPointerEvent): any; + onMsPointerOut?(ev: MSPointerEvent): any; + onMsPointerOutCapture?(ev: MSPointerEvent): any; + onMsPointerOver?(ev: MSPointerEvent): any; + onMsPointerOverCapture?(ev: MSPointerEvent): any; + oNmsPointerUp?(ev: MSPointerEvent): any; + oNmsPointerUpCapture?(ev: MSPointerEvent): any; + onOffline?(ev: Event): any; + onOfflineCapture?(ev: Event): any; + onOnline?(ev: Event): any; + onOnlineCapture?(ev: Event): any; + onOrientationChange?(ev: Event): any; + onOrientationChangeCapture?(ev: Event): any; + onPageHide?(ev: PageTransitionEvent): any; + onPageHideCapture?(ev: PageTransitionEvent): any; + onPageShow?(ev: PageTransitionEvent): any; + onPageShowCapture?(ev: PageTransitionEvent): any; + onPause?(ev: Event): any; + onPauseCapture?(ev: Event): any; + onPlay?(ev: Event): any; + onPlayCapture?(ev: Event): any; + onPlaying?(ev: Event): any; + onPlayingCapture?(ev: Event): any; + onPopState?(ev: PopStateEvent): any; + onPopStateCapture?(ev: PopStateEvent): any; + onProgress?(ev: ProgressEvent): any; + onProgressCapture?(ev: ProgressEvent): any; + onRateChange?(ev: Event): any; + onRateChangeCapture?(ev: Event): any; + onReadyStateChange?(ev: ProgressEvent): any; + onReadyStateChangeCapture?(ev: ProgressEvent): any; + onReset?(ev: Event): any; + onResetCapture?(ev: Event): any; + onResize?(ev: UIEvent): any; + onResizeCapture?(ev: UIEvent): any; + onScroll?(ev: UIEvent): any; + onScrollCapture?(ev: UIEvent): any; + onSeeked?(ev: Event): any; + onSeekedCapture?(ev: Event): any; + onSeeking?(ev: Event): any; + onSeekingCapture?(ev: Event): any; + onSelect?(ev: UIEvent): any; + onSelectCapture?(ev: UIEvent): any; + onStalled?(ev: Event): any; + onStalledCapture?(ev: Event): any; + onStorage?(ev: StorageEvent): any; + onStorageCapture?(ev: StorageEvent): any; + onSubmit?(ev: Event): any; + onSubmitCapture?(ev: Event): any; + onSuspend?(ev: Event): any; + onSuspendCapture?(ev: Event): any; + onTimeUpdate?(ev: Event): any; + onTimeUpdateCapture?(ev: Event): any; onTouchCancel?: any; onTouchCancelCapture?: any; onTouchEnd?: any; @@ -211,12 +211,12 @@ export interface EventListenerProps { onTouchMoveCapture?: any; onTouchStart?: any; onTouchStartCapture?: any; - onUnload?: (ev: Event) => any; - onUnloadCapture?: (ev: Event) => any; - onVolumeChange?: (ev: Event) => any; - onVolumeChangeCapture?: (ev: Event) => any; - onWaiting?: (ev: Event) => any; - onWaitingCapture?: (ev: Event) => any; + onUnload?(ev: Event): any; + onUnloadCapture?(ev: Event): any; + onVolumeChange?(ev: Event): any; + onVolumeChangeCapture?(ev: Event): any; + onWaiting?(ev: Event): any; + onWaitingCapture?(ev: Event): any; /** * Target (window or document) diff --git a/types/react-facebook-login/index.d.ts b/types/react-facebook-login/index.d.ts index 577846e4a5..9f83d7ae8b 100644 --- a/types/react-facebook-login/index.d.ts +++ b/types/react-facebook-login/index.d.ts @@ -9,7 +9,7 @@ import * as React from "react"; declare namespace ReactFacebookLogin { interface ReactFacebookLoginProps { appId: string; - callback: (userInfo: ReactFacebookLoginInfo) => void; + callback(userInfo: ReactFacebookLoginInfo): void; autoLoad?: boolean; buttonStyle?: React.CSSProperties; @@ -21,7 +21,7 @@ declare namespace ReactFacebookLogin { icon?: string | React.ReactNode; isDisabled?: boolean; language?: string; - onClick?: () => void; + onClick?(): void; reAuthenticate?: boolean; redirectUri?: string; scope?: string; diff --git a/types/react-gravatar/index.d.ts b/types/react-gravatar/index.d.ts index 3e33584a4b..9307c6fb93 100644 --- a/types/react-gravatar/index.d.ts +++ b/types/react-gravatar/index.d.ts @@ -22,10 +22,10 @@ declare class Gravatar extends React.Component { } declare namespace Gravatar { - export type DefaultImage = "404" | "mm" | "identicon" | "monsterid" | "wavatar" | "retro" | "blank"; - export type Rating = "g" | "pg" | "r" | "x"; + type DefaultImage = "404" | "mm" | "identicon" | "monsterid" | "wavatar" | "retro" | "blank"; + type Rating = "g" | "pg" | "r" | "x"; - export interface Props { + interface Props { /** * The email address used to look up the Gravatar image. * If you wish to avoid sending an email address to the client, you can compute the md5 hash on the server and diff --git a/types/react-gravatar/react-gravatar-tests.tsx b/types/react-gravatar/react-gravatar-tests.tsx index e3b36b7259..1dee72f2c9 100644 --- a/types/react-gravatar/react-gravatar-tests.tsx +++ b/types/react-gravatar/react-gravatar-tests.tsx @@ -37,4 +37,4 @@ class GravatarMinimalTest extends React.Component { render() { return ; } -} \ No newline at end of file +} diff --git a/types/react-highlight-words/index.d.ts b/types/react-highlight-words/index.d.ts index aae2eff04e..220c245638 100644 --- a/types/react-highlight-words/index.d.ts +++ b/types/react-highlight-words/index.d.ts @@ -22,7 +22,7 @@ interface HighlighterProps { /** Type of tag to wrap around highlighted matches; defaults to mark */ highlightTag?: string; /** Process each search word and text to highlight before comparing (eg remove accents); signature (text: string): string */ - sanitize?: (text: string) => string; + sanitize?(text: string): string; /** Array of search words */ searchWords: string[]; /** Text to highlight matches in */ diff --git a/types/react-highlighter/react-highlighter-tests.tsx b/types/react-highlighter/react-highlighter-tests.tsx index 9065bd1fab..79760228dd 100644 --- a/types/react-highlighter/react-highlighter-tests.tsx +++ b/types/react-highlighter/react-highlighter-tests.tsx @@ -10,4 +10,4 @@ export class ReactHolderTest extends React.Component { ); } -} \ No newline at end of file +} diff --git a/types/react-icon-base/index.d.ts b/types/react-icon-base/index.d.ts index c0246569f6..600d33dff7 100644 --- a/types/react-icon-base/index.d.ts +++ b/types/react-icon-base/index.d.ts @@ -12,6 +12,4 @@ export interface IconBaseProps { style?: React.CSSProperties; } -export default class IconBase extends React.Component { - -} \ No newline at end of file +export default class IconBase extends React.Component {} diff --git a/types/react-icon-base/react-icon-base-tests.tsx b/types/react-icon-base/react-icon-base-tests.tsx index 68388f69d6..16ebafd133 100644 --- a/types/react-icon-base/react-icon-base-tests.tsx +++ b/types/react-icon-base/react-icon-base-tests.tsx @@ -1,4 +1,4 @@ import * as React from 'react'; import IconBase from 'react-icon-base'; -export default ; \ No newline at end of file +export default ; diff --git a/types/react-icons/react-icons-tests.tsx b/types/react-icons/react-icons-tests.tsx index 0c37cc9da2..1cb773fb4d 100644 --- a/types/react-icons/react-icons-tests.tsx +++ b/types/react-icons/react-icons-tests.tsx @@ -7,5 +7,3 @@ class Question extends React.Component { return

    Lets go for a ?

    ; } } - - diff --git a/types/react-icons/tslint.json b/types/react-icons/tslint.json index 377cc837d4..05b3b474eb 100644 --- a/types/react-icons/tslint.json +++ b/types/react-icons/tslint.json @@ -1 +1,8 @@ -{ "extends": "../tslint.json" } +{ + "extends": "../tslint.json", + "rules": { + "eofline": false, + "no-useless-files": false, + "no-var": false + } +} diff --git a/types/react-input-mask/index.d.ts b/types/react-input-mask/index.d.ts index fe6cc718e4..560dc8cc2b 100644 --- a/types/react-input-mask/index.d.ts +++ b/types/react-input-mask/index.d.ts @@ -7,7 +7,7 @@ import * as React from "react"; declare namespace reactInputMask { - export interface ReactInputMaskProps extends React.HTMLAttributes { + interface ReactInputMaskProps extends React.HTMLAttributes { /** * Mask string. Format characters are: * * `9`: `0-9` @@ -37,7 +37,7 @@ declare namespace reactInputMask { */ alwaysShowMask?: boolean; } - export class ReactInputMask extends React.Component { + class ReactInputMask extends React.Component { } } declare var ReactInputMask: typeof reactInputMask.ReactInputMask; diff --git a/types/react-joyride/index.d.ts b/types/react-joyride/index.d.ts index 1a6d674ed4..ebc086770b 100644 --- a/types/react-joyride/index.d.ts +++ b/types/react-joyride/index.d.ts @@ -130,7 +130,7 @@ interface Props { /** * It will be called when the tour's state changes. */ - callback?: (options: any) => void; + callback?(options: any): void; } export interface Step { diff --git a/types/react-json-pretty/index.d.ts b/types/react-json-pretty/index.d.ts index bf165faaf5..00f3f8b4ff 100644 --- a/types/react-json-pretty/index.d.ts +++ b/types/react-json-pretty/index.d.ts @@ -14,9 +14,7 @@ declare const JSONPretty: JSONPretty; type JSONPretty = ComponentClass; declare namespace JSONPretty { - - export interface JSONPrettyProps extends HTMLProps { + interface JSONPrettyProps extends HTMLProps { json: {} | string; } - } diff --git a/types/react-leaflet/index.d.ts b/types/react-leaflet/index.d.ts index 8caed9e4e1..9414e11f77 100644 --- a/types/react-leaflet/index.d.ts +++ b/types/react-leaflet/index.d.ts @@ -11,59 +11,59 @@ import * as React from 'react'; // which already declares things with some of the same names interface LeafletLayerEvents { - onbaselayerchange?: (event: Leaflet.LayersControlEvent) => void; - onoverlayadd?: (event: Leaflet.LayersControlEvent) => void; - onoverlayremove?: (event: Leaflet.LayersControlEvent) => void; - onlayeradd?: (event: Leaflet.LayerEvent) => void; - onlayerremove?: (event: Leaflet.LayerEvent) => void; + onbaselayerchange?(event: Leaflet.LayersControlEvent): void; + onoverlayadd?(event: Leaflet.LayersControlEvent): void; + onoverlayremove?(event: Leaflet.LayersControlEvent): void; + onlayeradd?(event: Leaflet.LayerEvent): void; + onlayerremove?(event: Leaflet.LayerEvent): void; } interface LeafletMapStateChangeEvents { - onzoomlevelschange?: (event: Leaflet.Event) => void; - onresize?: (event: Leaflet.ResizeEvent) => void; - onunload?: (event: Leaflet.Event) => void; - onviewreset?: (event: Leaflet.Event) => void; - onload?: (event: Leaflet.Event) => void; - onzoomstart?: (event: Leaflet.Event) => void; - onmovestart?: (event: Leaflet.Event) => void; - onzoom?: (event: Leaflet.Event) => void; - onmove?: (event: Leaflet.Event) => void; - onzoomend?: (event: Leaflet.Event) => void; - onmoveend?: (event: Leaflet.Event) => void; + onzoomlevelschange?(event: Leaflet.Event): void; + onresize?(event: Leaflet.ResizeEvent): void; + onunload?(event: Leaflet.Event): void; + onviewreset?(event: Leaflet.Event): void; + onload?(event: Leaflet.Event): void; + onzoomstart?(event: Leaflet.Event): void; + onmovestart?(event: Leaflet.Event): void; + onzoom?(event: Leaflet.Event): void; + onmove?(event: Leaflet.Event): void; + onzoomend?(event: Leaflet.Event): void; + onmoveend?(event: Leaflet.Event): void; } interface LeafletPopupEvents { - onpopupopen?: (event: Leaflet.PopupEvent) => void; - onpopupclose?: (event: Leaflet.PopupEvent) => void; - onautopanstart?: (event: Leaflet.Event) => void; + onpopupopen?(event: Leaflet.PopupEvent): void; + onpopupclose?(event: Leaflet.PopupEvent): void; + onautopanstart?(event: Leaflet.Event): void; } interface LeafletTooltipEvents { - ontooltipopen?: (event: Leaflet.TooltipEvent) => void; - ontooltipclose?: (event: Leaflet.TooltipEvent) => void; + ontooltipopen?(event: Leaflet.TooltipEvent): void; + ontooltipclose?(event: Leaflet.TooltipEvent): void; } interface LeafletLocationEvents { - onlocationerror?: (event: Leaflet.ErrorEvent) => void; - onlocationfound?: (event: Leaflet.LocationEvent) => void; + onlocationerror?(event: Leaflet.ErrorEvent): void; + onlocationfound?(event: Leaflet.LocationEvent): void; } interface LeafletInteractionEvents { - onclick?: (event: Leaflet.MouseEvent) => void; - ondblclick?: (event: Leaflet.MouseEvent) => void; - onmousedown?: (event: Leaflet.MouseEvent) => void; - onmouseup?: (event: Leaflet.MouseEvent) => void; - onmouseover?: (event: Leaflet.MouseEvent) => void; - onmouseout?: (event: Leaflet.MouseEvent) => void; - onmousemove?: (event: Leaflet.MouseEvent) => void; - oncontextmenu?: (event: Leaflet.MouseEvent) => void; - onkeypress?: (event: Leaflet.KeyboardEvent) => void; - onpreclick?: (event: Leaflet.MouseEvent) => void; + onclick?(event: Leaflet.MouseEvent): void; + ondblclick?(event: Leaflet.MouseEvent): void; + onmousedown?(event: Leaflet.MouseEvent): void; + onmouseup?(event: Leaflet.MouseEvent): void; + onmouseover?(event: Leaflet.MouseEvent): void; + onmouseout?(event: Leaflet.MouseEvent): void; + onmousemove?(event: Leaflet.MouseEvent): void; + oncontextmenu?(event: Leaflet.MouseEvent): void; + onkeypress?(event: Leaflet.KeyboardEvent): void; + onpreclick?(event: Leaflet.MouseEvent): void; } interface LeafletOtherEvents { - onzoomanim?: (event: Leaflet.ZoomAnimEvent) => void; + onzoomanim?(event: Leaflet.ZoomAnimEvent): void; } interface LeafletDraggingEvents { - ondragstart?: (event: Leaflet.Event) => void; - onmovestart?: (event: Leaflet.Event) => void; - ondrag?: (event: Leaflet.Event) => void; - ondragend?: (event: Leaflet.DragEndEvent) => void; - onmoveend?: (event: Leaflet.Event) => void; + ondragstart?(event: Leaflet.Event): void; + onmovestart?(event: Leaflet.Event): void; + ondrag?(event: Leaflet.Event): void; + ondragend?(event: Leaflet.DragEndEvent): void; + onmoveend?(event: Leaflet.Event): void; } interface MapProps extends React.HTMLProps, @@ -92,16 +92,16 @@ export const Pane: React.ComponentClass; // There is no Layer class, these are the base props for all layers on the map interface LayerProps extends LeafletInteractionEvents { - onadd?: (event: Leaflet.Event) => void; - onremove?: (event: Leaflet.Event) => void; + onadd?(event: Leaflet.Event): void; + onremove?(event: Leaflet.Event): void; // Popup events - onpopupopen?: (event: Leaflet.PopupEvent) => void; - onpopupclose?: (event: Leaflet.PopupEvent) => void; + onpopupopen?(event: Leaflet.PopupEvent): void; + onpopupclose?(event: Leaflet.PopupEvent): void; // Tooltip events - ontooltipopen?: (event: Leaflet.TooltipEvent) => void; - ontooltipclose?: (event: Leaflet.TooltipEvent) => void; + ontooltipopen?(event: Leaflet.TooltipEvent): void; + ontooltipclose?(event: Leaflet.TooltipEvent): void; } interface MarkerProps extends LayerProps, LeafletDraggingEvents { @@ -129,12 +129,12 @@ interface GridLayerProps extends LayerProps { opacity?: number; zIndex?: number; - onloading?: (event: Leaflet.Event) => void; - ontileunload?: (event: Leaflet.TileEvent) => void; - ontileloadstart?: (event: Leaflet.TileEvent) => void; - ontileerror?: (event: Leaflet.TileErrorEvent) => void; - ontileload?: (event: Leaflet.TileEvent) => void; - onload?: (event: Leaflet.Event) => void; + onloading?(event: Leaflet.Event): void; + ontileunload?(event: Leaflet.TileEvent): void; + ontileloadstart?(event: Leaflet.TileEvent): void; + ontileerror?(event: Leaflet.TileErrorEvent): void; + ontileload?(event: Leaflet.TileEvent): void; + onload?(event: Leaflet.Event): void; } export const GridLayer: React.ComponentClass; @@ -221,8 +221,8 @@ export namespace LayersControl { interface MapControlProps { position?: Leaflet.ControlPosition; } -declare class MapControl extends React.Component { - leafletElement?: L.Control +export class MapControl extends React.Component { + leafletElement?: L.Control; } interface ScaleControlProps { diff --git a/types/react-leaflet/react-leaflet-tests.tsx b/types/react-leaflet/react-leaflet-tests.tsx index 3c928dc322..7646109d69 100644 --- a/types/react-leaflet/react-leaflet-tests.tsx +++ b/types/react-leaflet/react-leaflet-tests.tsx @@ -603,8 +603,7 @@ const ZoomControlExample = () => ( ); - -//MapControl https://github.com/PaulLeCam/react-leaflet/issues/130 +// MapControl https://github.com/PaulLeCam/react-leaflet/issues/130 const mapControlCenter: [number, number] = [51.505, -0.09]; class CenterControl extends MapControl { // note we're extending MapControl from react-leaflet, not Component from react componentWillMount() { @@ -612,7 +611,7 @@ class CenterControl extends MapControl { // note we're extendi const jsx = ( // PUT YOUR JSX FOR THE COMPONENT HERE:
    - // add your JSX + // add your JSX
    ); @@ -665,4 +664,4 @@ const LegendControlExample = () => ( -); \ No newline at end of file +); diff --git a/types/react-modal/index.d.ts b/types/react-modal/index.d.ts index d4a772366c..bb158bc6be 100644 --- a/types/react-modal/index.d.ts +++ b/types/react-modal/index.d.ts @@ -28,9 +28,9 @@ declare namespace ReactModal { /* Set this to properly hide your application from assistive screenreaders and other assistive technologies while the modal is open. */ appElement?: HTMLElement | {}; /* Function that will be run after the modal has opened. */ - onAfterOpen?: () => void; + onAfterOpen?(): void; /* Function that will be run when the modal is requested to be closed, prior to actually closing. */ - onRequestClose?: (event: (MouseEvent | KeyboardEvent)) => void; + onRequestClose?(event: (MouseEvent | KeyboardEvent)): void; /* Number indicating the milliseconds to wait before closing the modal. Defaults to zero (no timeout). */ closeTimeoutMS?: number; /* Boolean indicating if the appElement should be hidden. Defaults to true. */ @@ -48,7 +48,7 @@ declare namespace ReactModal { /* String indicating the role of the modal, allowing the 'dialog' role to be applied if desired. */ role?: string; /* Function that will be called to get the parent element that the modal will be attached to. */ - parentSelector?: () => HTMLElement; + parentSelector?(): HTMLElement; } } diff --git a/types/react-modal/react-modal-tests.tsx b/types/react-modal/react-modal-tests.tsx index d85796c065..51cdffba0a 100644 --- a/types/react-modal/react-modal-tests.tsx +++ b/types/react-modal/react-modal-tests.tsx @@ -42,4 +42,4 @@ class ExampleOfUsingReactModal extends React.Component<{}, {}> { ); } -}; +} diff --git a/types/react-native-datepicker/index.d.ts b/types/react-native-datepicker/index.d.ts index 232f2f56d1..ab3831dde8 100644 --- a/types/react-native-datepicker/index.d.ts +++ b/types/react-native-datepicker/index.d.ts @@ -18,9 +18,9 @@ interface DatePickerProps { cancelBtnText?: string; showIcon?: boolean; disabled?: boolean; - onDateChange?: (dateStr: string, date: Date) => void; + onDateChange?(dateStr: string, date: Date): void; placeholder?: string; - modalOnResponderTerminationRequest?: (e: any) => boolean; + modalOnResponderTerminationRequest?(e: any): boolean; is24Hour?: boolean; style?: any; customStyles?: any; diff --git a/types/react-native-datepicker/react-native-datepicker-tests.tsx b/types/react-native-datepicker/react-native-datepicker-tests.tsx index 22af7674d8..cce86882f8 100644 --- a/types/react-native-datepicker/react-native-datepicker-tests.tsx +++ b/types/react-native-datepicker/react-native-datepicker-tests.tsx @@ -39,4 +39,3 @@ export default class MyDatePicker extends React.Component<{}, MyDatePickerState> ); } } - diff --git a/types/react-native-google-analytics-bridge/index.d.ts b/types/react-native-google-analytics-bridge/index.d.ts index 38afee3512..1edf5514e2 100644 --- a/types/react-native-google-analytics-bridge/index.d.ts +++ b/types/react-native-google-analytics-bridge/index.d.ts @@ -3,8 +3,7 @@ // Definitions by: Huhuanming // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - export class GoogleAnalyticsTracker { +export class GoogleAnalyticsTracker { /** * Save all tracker related data that is needed to call native methods with proper data. * @param trackerId {String} @@ -22,13 +21,13 @@ * @param customDimensions {Object} * @returns {Object} */ - transformCustomDimensionsFieldsToIndexes(customDimensions: {}): void + transformCustomDimensionsFieldsToIndexes(customDimensions: {}): void; /** * Track the current screen/view * @param {String} screenName The name of the current screen */ - trackScreenView(screenName: string): void + trackScreenView(screenName: string): void; /** * Track an event that has occured @@ -36,14 +35,14 @@ * @param {String} action The event action * @param {Object} optionalValues An object containing optional label and value */ - trackEvent(category: string, action: string, optionalValues?: {}): void + trackEvent(category: string, action: string, optionalValues?: {}): void; /** * Track the current screen/view with custom dimension values * @param {String} screenName The name of the current screen * @param {Object} customDimensionValues An object containing custom dimension key/value pairs */ - trackScreenViewWithCustomDimensionValues(screenName: string, customDimensionValues: {}): void + trackScreenViewWithCustomDimensionValues(screenName: string, customDimensionValues: {}): void; /** * Track an event that has occured with custom dimension values @@ -57,7 +56,7 @@ action: string, optionalValues: {}, customDimensionValues: {}, - ): void + ): void; /** * Track an event that has occured @@ -65,7 +64,7 @@ * @param {Number} value The timing measurement in milliseconds * @param {Object} optionalValues An object containing optional name and label */ - trackTiming(category: string, value: number, optionalValues: {}): void + trackTiming(category: string, value: number, optionalValues: {}): void; /** * Track a purchase event. This uses the Enhanced Ecommerce GA feature. @@ -79,7 +78,7 @@ transaction: {}, eventCategory?: string, eventAction?: string, - ): void + ): void; /** * Track a purchase event. This uses the Enhanced Ecommerce GA feature. @@ -89,11 +88,11 @@ * @param {String} eventAction The event action, defaults to Purchase */ trackMultiProductsPurchaseEvent( - products: {}[], + products: Array<{}>, ransaction: {}, eventCategory?: string, eventAction?: string - ): void + ): void; /** * Track a purchase event with custom dimensions. This uses the Enhanced Ecommerce GA feature. @@ -104,31 +103,31 @@ * @param {Object} customDimensionValues An object containing custom dimension key/value pairs */ trackMultiProductsPurchaseEventWithCustomDimensionValues( - products: {}[], + products: Array<{}>, transaction: {}, eventCategory?: string, eventAction?: string, customDimensions?: {}, - ): void + ): void; /** * Track an exception * @param {String} error The description of the error * @param {Boolean} fatal A value indiciating if the error was fatal, defaults to false */ - trackException(error: string, fatal?: boolean): void + trackException(error: string, fatal?: boolean): void; /** * Sets the current userId for tracking. * @param {String} userId The current userId */ - setUser(userId: string): void + setUser(userId: string): void; /** * Sets if IDFA (identifier for advertisers) collection should be enabled * @param {Boolean} enabled Defaults to true */ - allowIDFA(enabled?: boolean): void + allowIDFA(enabled?: boolean): void; /** * Track a social interaction, Facebook, Twitter, etc. @@ -136,70 +135,70 @@ * @param {String} action * @param {String} targetUrl */ - trackSocialInteraction(network: string, action: string, targetUrl: string): void + trackSocialInteraction(network: string, action: string, targetUrl: string): void; /** * Sets if uncaught exceptions should be tracked * @param {Boolean} enabled */ - setTrackUncaughtExceptions(enabled: boolean): void + setTrackUncaughtExceptions(enabled: boolean): void; /** * Sets the trackers appName * The Bundle name is used by default * @param {String} appName */ - setAppName(appName: string): void + setAppName(appName: string): void; /** * Sets the trackers appVersion * @param {String} appVersion */ - setAppVersion(appVersion: string): void + setAppVersion(appVersion: string): void; /** * Sets if AnonymizeIp is enabled * If enabled the last octet of the IP address will be removed * @param {Boolean} enabled */ - setAnonymizeIp(enabled: string): void + setAnonymizeIp(enabled: string): void; /** * Sets tracker sampling rate. * @param {Float} sampleRatio Percentage 0 - 100 */ - setSamplingRate(sampleRatio: number): void - } + setSamplingRate(sampleRatio: number): void; +} - interface GAEvent { - event: string - payload: T - } +interface GAEvent { + event: string; + payload: T; +} - export class GoogleTagManager { +export class GoogleTagManager { /** * Call once to open the container for all subsequent static calls. * @param {String} containerId */ - static openContainerWithId(containerId: string): void + static openContainerWithId(containerId: string): void; /** * Retrieves a boolean value with the given key from the opened container. * @param {String} key */ - static boolForKey(key: string): boolean + static boolForKey(key: string): boolean; /** * Retrieves a string with the given key from the opened container. * @param {String} key */ - static stringForKey(key: string): string + static stringForKey(key: string): string; /** * Retrieves a number with the given key from the opened container. * @param {String} key */ - static doubleForKey(key: string): number + static doubleForKey(key: string): number; /** * push a datalayer event for Google Analytics through Google Tag Manager. @@ -207,16 +206,16 @@ * it must have at least one key "event" with event name * example: {event: "eventName", pageId: "/home"} */ - static pushDataLayerEvent(dictionary: GAEvent): void - } + static pushDataLayerEvent(dictionary: GAEvent): void; +} - export class GoogleAnalyticsSettings { +export class GoogleAnalyticsSettings { /** * Sets if OptOut is active and disables Google Analytics * This has to be set each time the App starts * @param {Boolean} enabled */ - static setOptOut(enabled: boolean): void + static setOptOut(enabled: boolean): void; /** * Sets the trackers dispatch interval @@ -224,12 +223,12 @@ * are sent to your tracker. * @param {Number} intervalInSeconds */ - static setDispatchInterval(intervalInSeconds: number): void + static setDispatchInterval(intervalInSeconds: number): void; /** * Sets if the tracker should have dry run enabled. * If dry run is enabled, no analytics data will be sent to your tracker. * @param {Boolean} enabled */ - static setDryRun(enabled: boolean): void - } + static setDryRun(enabled: boolean): void; +} diff --git a/types/react-native-google-analytics-bridge/react-native-google-analytics-bridge-tests.ts b/types/react-native-google-analytics-bridge/react-native-google-analytics-bridge-tests.ts index 3f9835fb83..8e365cb01d 100644 --- a/types/react-native-google-analytics-bridge/react-native-google-analytics-bridge-tests.ts +++ b/types/react-native-google-analytics-bridge/react-native-google-analytics-bridge-tests.ts @@ -2,27 +2,26 @@ import { GoogleAnalyticsTracker, GoogleTagManager, GoogleAnalyticsSettings, -} from './index' +} from 'react-native-google-analytics-bridge'; -const tracker = new GoogleAnalyticsTracker('GA_UA') +const tracker = new GoogleAnalyticsTracker('GA_UA'); -tracker.allowIDFA() -tracker.allowIDFA(true) +tracker.allowIDFA(); +tracker.allowIDFA(true); -tracker.setAnonymizeIp('1.1.1.1') +tracker.setAnonymizeIp('1.1.1.1'); -tracker.setAppName('name') +tracker.setAppName('name'); -GoogleTagManager.openContainerWithId('123') -GoogleTagManager.boolForKey('key') -GoogleTagManager.stringForKey('key') -GoogleTagManager.doubleForKey('key') +GoogleTagManager.openContainerWithId('123'); +GoogleTagManager.boolForKey('key'); +GoogleTagManager.stringForKey('key'); +GoogleTagManager.doubleForKey('key'); GoogleTagManager.pushDataLayerEvent({ event: 'event', payload: 'payload', -}) - -GoogleAnalyticsSettings.setOptOut(true) -GoogleAnalyticsSettings.setDispatchInterval(1000) -GoogleAnalyticsSettings.setDryRun(true) +}); +GoogleAnalyticsSettings.setOptOut(true); +GoogleAnalyticsSettings.setDispatchInterval(1000); +GoogleAnalyticsSettings.setDryRun(true); diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index 3742bf5003..083c646be7 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -8418,7 +8418,7 @@ export function requireNativeComponent

    ( extraConfig?: {nativeOnly?: any} ): React.ComponentClass

    ; -export function findNodeHandle(componentOrHandle: null | number | React.Component): null | number; +export function findNodeHandle(componentOrHandle: null | number | React.Component | React.ComponentClass): null | number; export function processColor(color: any): number; diff --git a/types/react-native/test/index.tsx b/types/react-native/test/index.tsx index 575693211e..45a5b510e9 100644 --- a/types/react-native/test/index.tsx +++ b/types/react-native/test/index.tsx @@ -25,6 +25,7 @@ import { View, ViewStyle, ViewPagerAndroid, + findNodeHandle } from 'react-native'; function testDimensions() { @@ -88,20 +89,43 @@ const stylesAlt = StyleSheet.create( } ) +class CustomView extends React.Component<{}, {}> { + + render() { + return ( + Custom View + ); + } + +} class Welcome extends React.Component { refs: { - [key: string]: any - rootView: View + [key: string]: any + rootView: View + customView: CustomView } testNativeMethods() { - // this.setNativeProps({}); + // this.setNativeProps({}); - const { rootView } = this.refs; + const { rootView } = this.refs; + + rootView.measure((x: number, y: number, width: number, height: number) => { + }); + + } + + testFindNodeHandle() { + + const { rootView, customView } = this.refs; + + let nativeComponentHandle = findNodeHandle(rootView); + + let customComponentHandle = findNodeHandle(customView); + + let fromHandle = findNodeHandle(customComponentHandle); - rootView.measure((x: number, y: number, width: number, height: number) => { - }); } render() { @@ -117,6 +141,7 @@ class Welcome extends React.Component { Press Cmd+R to reload,{'\n'} Cmd+D or shake for dev menu + ) } diff --git a/types/react-native/tslint.json b/types/react-native/tslint.json index b58d132131..7bd0b4c549 100644 --- a/types/react-native/tslint.json +++ b/types/react-native/tslint.json @@ -4,9 +4,11 @@ // Lowercase `object` is available in TypeScript 2.2 only. "ban-types": false, // Below are all TODO + "align": false, "array-type": false, "comment-format": false, "interface-over-type-literal": false, + "jsdoc-format": false, "no-misused-new": false, "no-consecutive-blank-lines": false, "no-empty-interface": false, diff --git a/types/react-onsenui/index.d.ts b/types/react-onsenui/index.d.ts index 3ce4a26686..5c25131be1 100644 --- a/types/react-onsenui/index.d.ts +++ b/types/react-onsenui/index.d.ts @@ -5,32 +5,32 @@ // TypeScript Version: 2.1 import { Component } from 'react'; -declare interface Modifiers_string { - default?: string, - material?: string +export interface Modifiers_string { + default?: string; + material?: string; } -declare interface Modifiers_number { - default?: number, - material?: number +export interface Modifiers_number { + default?: number; + material?: number; } -declare interface AnimationOptions { - duration?: number, - delay?: number, - timing?: string +export interface AnimationOptions { + duration?: number; + delay?: number; + timing?: string; } /*** splitter ***/ -declare class SplitterSide extends Component<{ +export class SplitterSide extends Component<{ side?: "left" | "right", collapse?: "portrait" | "landscape" | boolean, isOpen?: boolean, - onOpen?: (e?: Event) => void, - onPreOpen?: (e?: Event) => void, - onPreClose?: (e?: Event) => void, - onModeChange?: (e?: Event) => void, - onClose?: (e?: Event) => void, + onOpen?(e?: Event): void, + onPreOpen?(e?: Event): void, + onPreClose?(e?: Event): void, + onModeChange?(e?: Event): void, + onClose?(e?: Event): void, isSwipeable?: boolean, swipeTargetWidth?: number, width?: number, @@ -38,80 +38,77 @@ declare class SplitterSide extends Component<{ animationOptions?: AnimationOptions, openThreshold?: number, mode?: "collapse" | "split" -}, any>{ } +}, any> { } +export class SplitterContent extends Component<{}, any> { } -declare class SplitterContent extends Component<{}, any> { } - -declare class Splitter extends Component<{}, any> { } +export class Splitter extends Component<{}, any> { } /*** toolbar ***/ -declare class Toolbar extends Component<{}, any>{} +export class Toolbar extends Component<{}, any> {} - -declare class BottomToolbar extends Component<{ +export class BottomToolbar extends Component<{ modifier?: string -}, any>{} +}, any> {} - -declare class ToolbarButton extends Component<{ +export class ToolbarButton extends Component<{ modifier?: string, disabled?: boolean, - onClick?: (e?: Event) => void -}, any>{} + onClick?(e?: Event): void +}, any> {} /*** icon ***/ -declare class Icon extends Component<{ +export class Icon extends Component<{ modifier?: string, icon?: string | Modifiers_string, size?: number | Modifiers_number, rotate?: 90 | 180 | 270, fixedWidth?: boolean, spin?: boolean -}, any>{} +}, any> {} /*** page ***/ -declare class Page extends Component<{ +export class Page extends Component<{ contentStyle?: any, modifier?: string, - renderModal?: () => void, - renderToolbar?: () => void, - renderBottomToolbar?: () => void, - renderFixed?: () => void, - onInit?: () => void, - onShow?: () => void, - onHide?: () => void -}, any>{} + renderModal?(): void, + renderToolbar?(): void, + renderBottomToolbar?(): void, + renderFixed?(): void, + onInit?(): void, + onShow?(): void, + onHide?(): void +}, any> {} /*** Grid ***/ -declare class Col extends Component<{ +export class Col extends Component<{ verticalAlign?: "top" | "bottom" | "center", width?: string -}, any>{} +}, any> {} -declare class Row extends Component<{ +export class Row extends Component<{ verticalAlign?: "top" | "bottom" | "center", -}, any>{} +}, any> {} /*** Navigation ***/ -declare class BackButton extends Component<{ +export class BackButton extends Component<{ modifier?: string, - onClick?: (navigator: Navigator) => void -}, any>{} + onClick?(navigator: Navigator): void +}, any> {} -declare class Navigator extends Component<{ - renderPage: () => any, +export class Navigator extends Component<{ + renderPage(): any, initialRouteStack?: string[], initialRoute?: any, - onPrePush?: () => void, - onPostPush?: () => void, - onPrePop?: () => void, - onPostPop?: () => void, + onPrePush?(): void, + onPostPush?(): void, + onPrePop?(): void, + onPostPop?(): void, animation?: "slide" | "lift" | "fade" | "none" | string, animationOptions?: AnimationOptions -}, any>{ +}, any> { resetPage(route: any, options: any): void; resetPageStack(route: any, options: any): void; pushPage(route: any, options: any): void; @@ -119,7 +116,7 @@ declare class Navigator extends Component<{ } /*** Carousel ***/ -declare class Carousel extends Component<{ +export class Carousel extends Component<{ direction?: "horizontal" | "vertical", fullscreen?: boolean, overscrollable?: boolean, @@ -132,19 +129,19 @@ declare class Carousel extends Component<{ disabled?: boolean, index?: number, autoRefresh?: boolean, - onPostChange?: () => void, - onRefresh?: () => void, - onOverscroll?: () => void + onPostChange?(): void, + onRefresh?(): void, + onOverscroll?(): void animationOptions?: AnimationOptions -}, any>{} +}, any> {} -declare class CarouselItem extends Component<{ +export class CarouselItem extends Component<{ modifier: string -}, any>{} +}, any> {} /*** AlertDialog ***/ -declare class AlertDialog extends Component<{ - onCancel?: () => void, +export class AlertDialog extends Component<{ + onCancel?(): void, isOpen?: boolean, isCancelable?: boolean, isDisabled?: boolean, @@ -152,14 +149,14 @@ declare class AlertDialog extends Component<{ modifier?: string, maskColor?: string, animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} + onPreShow?(): void, + onPostShow?(): void, + onPreHide?(): void, + onPostHide?(): void, +}, any> {} -declare class Dialog extends Component<{ - onCancel?: () => void, +export class Dialog extends Component<{ + onCancel?(): void, isOpen?: boolean, isCancelable?: boolean, isDisabled?: boolean, @@ -167,23 +164,23 @@ declare class Dialog extends Component<{ modifier?: string, maskColor?: string, animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} + onPreShow?(): void, + onPostShow?(): void, + onPreHide?(): void, + onPostHide?(): void, +}, any> {} -declare class Modal extends Component<{ +export class Modal extends Component<{ animation?: "fade" | "none", animationOptions?: AnimationOptions - onShow?: () => void, - onHide?: () => void, + onShow?(): void, + onHide?(): void, isOpen?: boolean -}, any>{} +}, any> {} -declare class Popover extends Component<{ - getTarget?: () => Component | HTMLElement, - onCancel?: () => void, +export class Popover extends Component<{ + getTarget?(): Component | HTMLElement, + onCancel?(): void, isOpen?: boolean, isCancelable?: boolean, isDisabled?: boolean, @@ -191,52 +188,52 @@ declare class Popover extends Component<{ modifier?: string, maskColor?: string, animationOptions?: AnimationOptions, - onPreShow?: () => void, - onPostShow?: () => void, - onPreHide?: () => void, - onPostHide?: () => void, -}, any>{} + onPreShow?(): void, + onPostShow?(): void, + onPreHide?(): void, + onPostHide?(): void, +}, any> {} -declare class ProgressBar extends Component<{ +export class ProgressBar extends Component<{ modifier?: string, value?: number, secondaryValue?: boolean, intermediate?: boolean, }, any> {} -declare class ProgressCircular extends Component<{ +export class ProgressCircular extends Component<{ modifier?: string, value?: number, secondaryValue?: boolean, intermediate?: boolean, -}, any>{} +}, any> {} -declare class Ripple extends Component<{ +export class Ripple extends Component<{ color?: string, background?: string, disabled?: boolean, -}, any>{} +}, any> {} /*** Forms ***/ -declare class Fab extends Component<{ +export class Fab extends Component<{ modifier?: string, ripple?: boolean, position?: string, disabled?: boolean, - onClick?: () => void, -}, any>{} + onClick?(): void, +}, any> {} -declare class Button extends Component<{ +export class Button extends Component<{ modifier?: string, disabled?: boolean, ripple?: boolean, - onClick?: (e?: Event) => void -}, any>{} + onClick?(e?: Event): void +}, any> {} -declare class Input extends Component<{ +export class Input extends Component<{ modifier?: string, disabled?: boolean, - onChange?: (e: Event) => void, + onChange?(e: Event): void, value?: string, checked?: boolean, placeholder?: string, @@ -245,70 +242,67 @@ declare class Input extends Component<{ float?: boolean, }, any> {} -declare class Range extends Component<{ +export class Range extends Component<{ modifier?: string, - onChange?: (e: Event) => void, + onChange?(e: Event): void, value?: number, disabled?: boolean, -}, any>{} +}, any> {} -declare class Switch extends Component<{ - onChange?: (e: Event) => void, +export class Switch extends Component<{ + onChange?(e: Event): void, checked?: boolean, disabled?: boolean, inputId?: string -}, any>{} +}, any> {} /** -* Tabs -*/ + * Tabs + */ -declare class Tab extends Component<{}, any>{ } +export class Tab extends Component<{}, any> { } -declare class TabActive extends Component<{}, any>{ } +export class TabActive extends Component<{}, any> { } -declare class TabInactive extends Component<{}, any>{ } +export class TabInactive extends Component<{}, any> { } -declare class Tabbar extends Component<{ +export class Tabbar extends Component<{ index?: number, - renderTabs?: () => any, + renderTabs?(): any, position?: "bottom" | "top" | "auto", animation: "none" | "slide" | "fade", animationOptions?: AnimationOptions, - onPreChange?: () => void, - onPostChange?: () => void, - onReactive?: () => void, + onPreChange?(): void, + onPostChange?(): void, + onReactive?(): void, }, any> { } - /** -* Lists -*/ + * Lists + */ -declare class LazyList extends Component<{ +export class LazyList extends Component<{ modifier?: string, length?: number, - renderRow: (rowIndex: number) => any, - calculateItemHeight: (rowIndex: number) => any, -}, any>{ } + renderRow(rowIndex: number): any, + calculateItemHeight(rowIndex: number): any, +}, any> { } -declare class List extends Component<{ +export class List extends Component<{ modifier?: string, dataSource?: string[], - renderRow?: () => void, - renderHeader?: () => void, - renderFooter?: () => void, -}, any>{} + renderRow?(): void, + renderHeader?(): void, + renderFooter?(): void, +}, any> {} -declare class ListHeader extends Component<{ +export class ListHeader extends Component<{ modifier?: string, -}, any>{} +}, any> {} -declare class ListItem extends Component<{ +export class ListItem extends Component<{ modifier?: string, tappable?: boolean, tapBackgroundColor?: string, lockOnDrag?: boolean, -}, any>{} - - +}, any> {} diff --git a/types/react-onsenui/react-onsenui-tests.tsx b/types/react-onsenui/react-onsenui-tests.tsx index b72e8c3a37..fdc498fa17 100644 --- a/types/react-onsenui/react-onsenui-tests.tsx +++ b/types/react-onsenui/react-onsenui-tests.tsx @@ -6,11 +6,9 @@ class AppState { isOpen: boolean = false; } -interface AppProps { -} - -export class App extends React.Component{ +interface AppProps {} // tslint:disable-line no-empty-interface +export class App extends React.Component { constructor(props?: AppProps) { super(props); this.state = new AppState(); @@ -21,7 +19,6 @@ export class App extends React.Component{ } render() { - return ( { ); } - } - -ReactDOM.render(, document.getElementById('react-body')); \ No newline at end of file +ReactDOM.render(, document.getElementById('react-body')); diff --git a/types/react-overlays/index.d.ts b/types/react-overlays/index.d.ts index 10b67d9d51..db292d7f52 100644 --- a/types/react-overlays/index.d.ts +++ b/types/react-overlays/index.d.ts @@ -58,37 +58,36 @@ interface AffixProps { /** * Callback fired when the right before the `affixStyle` and `affixStyle` props are rendered */ - onAffix?: () => void; + onAffix?(): void; /** * Callback fired after the component `affixStyle` and `affixClassName` props have been rendered. */ - onAffixed?: () => void; + onAffixed?(): void; /** * Callback fired when the right before the `topStyle` and `topClassName` props are rendered */ - onAffixTop?: () => void; + onAffixTop?(): void; /** * Callback fired after the component `topStyle` and `topClassName` props have been rendered. */ - onAffixedTop?: () => void; + onAffixedTop?(): void; /** * Callback fired when the right before the `bottomStyle` and `bottomClassName` props are rendered */ - onAffixBottom?: () => void; + onAffixBottom?(): void; /** * Callback fired after the component `bottomStyle` and `bottomClassName` props have been rendered. */ - onAffixedBottom?: () => void; + onAffixedBottom?(): void; } export class Affix extends React.Component { } // interface AutoAffixProps extends AffixProps { - /** * The logical container node or component for determining offset from bottom * of viewport, or a function that returns it @@ -155,32 +154,31 @@ interface TransitionProps { /** * Callback fired before the "entering" classes are applied */ - onEnter?: (element: Element) => void; + onEnter?(element: Element): void; /** * Callback fired after the "entering" classes are applied */ - onEntering?: (element: Element) => void; + onEntering?(element: Element): void; /** * Callback fired after the "enter" classes are applied */ - onEntered?: (element: Element) => void; + onEntered?(element: Element): void; /** * Callback fired before the "exiting" classes are applied */ - onExit?: (element: Element) => void; + onExit?(element: Element): void; /** * Callback fired after the "exiting" classes are applied */ - onExiting?: (element: Element) => void; + onExiting?(element: Element): void; /** * Callback fired after the "exited" classes are applied */ - onExited?: (element: Element) => void; + onExited?(element: Element): void; } export class Transition extends React.Component { } - diff --git a/types/react-overlays/lib/RootCloseWrapper.d.ts b/types/react-overlays/lib/RootCloseWrapper.d.ts index 0642bdcc52..384df80f4a 100644 --- a/types/react-overlays/lib/RootCloseWrapper.d.ts +++ b/types/react-overlays/lib/RootCloseWrapper.d.ts @@ -2,7 +2,7 @@ import * as React from "react"; // interface RootCloseWrapperProps { - onRootClose?: () => void; + onRootClose?(): void; children?: React.ReactNode; /** diff --git a/types/react-overlays/react-overlays-tests.tsx b/types/react-overlays/react-overlays-tests.tsx index dd151e10e9..bbe526853f 100644 --- a/types/react-overlays/react-overlays-tests.tsx +++ b/types/react-overlays/react-overlays-tests.tsx @@ -17,7 +17,6 @@ function testTransition() { ); } - class TestAffix extends React.Component<{}, {}> { render(): JSX.Element { return ( diff --git a/types/react-paginate/index.d.ts b/types/react-paginate/index.d.ts index 18636a8f6f..b6b50170c2 100644 --- a/types/react-paginate/index.d.ts +++ b/types/react-paginate/index.d.ts @@ -45,7 +45,7 @@ interface ReactPaginateProps { /** * The method to call when a page is clicked. Exposes the current page object as an argument. */ - onPageChange?: (selectedItem: {selected: number}) => void; + onPageChange?(selectedItem: {selected: number}): void; /** * The initial page selected. @@ -110,7 +110,7 @@ interface ReactPaginateProps { /** * The method is called to generate the href attribute value on tag a of each page element. */ - hrefBuilder?: (pageIndex: number) => void; + hrefBuilder?(pageIndex: number): void; } declare const ReactPaginate: React.ComponentClass; diff --git a/types/react-paginate/react-paginate-tests.tsx b/types/react-paginate/react-paginate-tests.tsx index 5f8f8f1994..31efb805ce 100644 --- a/types/react-paginate/react-paginate-tests.tsx +++ b/types/react-paginate/react-paginate-tests.tsx @@ -2,7 +2,6 @@ import * as React from "react"; import ReactPaginate = require("react-paginate"); class Test extends React.Component<{}, {}> { - render() { return ( { - closePortal: () => {}; + closePortal(): {}; } interface ReactPortalProps { @@ -15,10 +15,10 @@ interface ReactPortalProps { openByClickOn?: React.ReactElement; closeOnEsc?: boolean; closeOnOutsideClick?: boolean; - onOpen?: (node: HTMLDivElement) => {}; - beforeClose?: (node: HTMLDivElement, resetPortalState: () => void) => {}; - onClose?: () => {}; - onUpdate?: () => {}; + onOpen?(node: HTMLDivElement): {}; + beforeClose?(node: HTMLDivElement, resetPortalState: () => void): {}; + onClose?(): {}; + onUpdate?(): {}; } declare const ReactPortal: React.ComponentClass; diff --git a/types/react-portal/react-portal-tests.tsx b/types/react-portal/react-portal-tests.tsx index b192e297c7..f3bd6d4b83 100644 --- a/types/react-portal/react-portal-tests.tsx +++ b/types/react-portal/react-portal-tests.tsx @@ -4,7 +4,6 @@ import * as ReactDOM from "react-dom"; import * as Portal from "react-portal"; export default class App extends React.Component<{}, {}> { - render() { const button1 = ; @@ -17,10 +16,9 @@ export default class App extends React.Component<{}, {}> { ); } - } -export class PseudoModal extends React.Component<{ closePortal?: () => {} }, {}> { +export class PseudoModal extends React.Component<{ closePortal?(): {} }, {}> { render() { return (

    @@ -31,4 +29,4 @@ export class PseudoModal extends React.Component<{ closePortal?: () => {} }, {}> } } -ReactDOM.render(, document.getElementById('react-body')); \ No newline at end of file +ReactDOM.render(, document.getElementById('react-body')); diff --git a/types/react-recaptcha/index.d.ts b/types/react-recaptcha/index.d.ts index 39cca4037c..af6853efb3 100644 --- a/types/react-recaptcha/index.d.ts +++ b/types/react-recaptcha/index.d.ts @@ -10,16 +10,16 @@ export = Recaptcha; interface RecaptchaProps { className?: string; elementID?: string; - expiredCallback?: () => any; + expiredCallback?(): any; expiredCallbackName?: string; - onloadCallback?: () => any; + onloadCallback?(): any; onloadCallbackName?: string; render?: string; size?: string; tabindex?: string; theme?: "dark" | "light"; type?: string; - verifyCallback?: () => any; + verifyCallback?(): any; verifyCallbackName?: string; sitekey?: string; } diff --git a/types/react-recaptcha/react-recaptcha-tests.tsx b/types/react-recaptcha/react-recaptcha-tests.tsx index 624020cc62..d931e45ae3 100644 --- a/types/react-recaptcha/react-recaptcha-tests.tsx +++ b/types/react-recaptcha/react-recaptcha-tests.tsx @@ -7,4 +7,4 @@ ReactDOM.render( sitekey="xxxxxxxxxxxxxxxxxxxx" />, document.getElementById('example') -); \ No newline at end of file +); diff --git a/types/react-router-config/index.d.ts b/types/react-router-config/index.d.ts index 7c7c218557..4979cbfd6b 100644 --- a/types/react-router-config/index.d.ts +++ b/types/react-router-config/index.d.ts @@ -23,9 +23,9 @@ export interface RouteConfig { export interface MatchedRoute { route: RouteConfig; - match: match + match: match; } -export function matchRoutes(routes: RouteConfig[], pathname: string): MatchedRoute[]; +export function matchRoutes(routes: RouteConfig[], pathname: string): Array>; export function renderRoutes(routes: RouteConfig[] | undefined): JSX.Element; diff --git a/types/react-router-config/react-router-config-tests.tsx b/types/react-router-config/react-router-config-tests.tsx index 47b54927b8..d1d28f93c0 100644 --- a/types/react-router-config/react-router-config-tests.tsx +++ b/types/react-router-config/react-router-config-tests.tsx @@ -8,13 +8,13 @@ const Root = ({ route }: RouteConfigComponentProps) => ( {/* child routes won't render without this */} {renderRoutes(route && route.routes)}
    -) +); const Home = ({ route }: RouteConfigComponentProps) => (

    Home

    -) +); const Child = ({ route }: RouteConfigComponentProps) => (
    @@ -22,13 +22,13 @@ const Child = ({ route }: RouteConfigComponentProps) => ( {/* child routes won't render without this */} {renderRoutes(route && route.routes)}
    -) +); const GrandChild = () => (

    Grand Child

    -) +); // route config const routes: RouteConfig[] = [ @@ -44,7 +44,6 @@ const routes: RouteConfig[] = [ path: "/child/:id", component: Child, routes: [{ - path: "/child/:id/grand-child", component: GrandChild }] @@ -53,7 +52,7 @@ const routes: RouteConfig[] = [ } ]; -const branch: MatchedRoute<{}>[] = matchRoutes<{}>(routes, "/child/23"); +const branch: Array> = matchRoutes<{}>(routes, "/child/23"); // using the routes shown earlier, this returns // [ // routes[0], diff --git a/types/react-router-dom/index.d.ts b/types/react-router-dom/index.d.ts index 6ee8255cc7..6c480d46c0 100644 --- a/types/react-router-dom/index.d.ts +++ b/types/react-router-dom/index.d.ts @@ -24,41 +24,36 @@ declare module 'react-router-dom' { import * as React from 'react'; import * as H from 'history'; - interface BrowserRouterProps { basename?: string; - getUserConfirmation?: () => void; + getUserConfirmation?(): void; forceRefresh?: boolean; keyLength?: number; } class BrowserRouter extends React.Component {} - interface HashRouterProps { basename?: string; - getUserConfirmation?: () => void; + getUserConfirmation?(): void; hashType?: 'slash' | 'noslash' | 'hashbang'; } class HashRouter extends React.Component {} - interface LinkProps extends React.HTMLAttributes { to: H.LocationDescriptor; replace?: boolean; } class Link extends React.Component {} - interface NavLinkProps extends LinkProps { activeClassName?: string; activeStyle?: React.CSSProperties; exact?: boolean; strict?: boolean; - isActive?: (location: H.Location, props: any) => boolean; + isActive?(location: H.Location, props: any): boolean; } class NavLink extends React.Component {} - export { BrowserRouter, HashRouter, @@ -78,5 +73,5 @@ declare module 'react-router-dom' { matchPath, withRouter, RouterChildContext - } + }; } diff --git a/types/react-router/test/ModalGallery.tsx b/types/react-router/test/ModalGallery.tsx index ccaefe3adc..ae817e0cc9 100644 --- a/types/react-router/test/ModalGallery.tsx +++ b/types/react-router/test/ModalGallery.tsx @@ -17,7 +17,6 @@ import { // on top of the old screen. class ModalSwitch extends React.Component, void> { - // We can pass a location to that will tell it to // ignore the router's current location and use the location // prop instead. diff --git a/types/react-router/test/Recursive.tsx b/types/react-router/test/Recursive.tsx index 748e00a968..31b7c5fe29 100644 --- a/types/react-router/test/Recursive.tsx +++ b/types/react-router/test/Recursive.tsx @@ -15,7 +15,7 @@ const PEEPS = [ { id: 3, name: 'David', friends: [ 1, 2 ] } ] -const find = (id: number) => PEEPS.find(p => p.id == id) +const find = (id: number) => PEEPS.find(p => p.id === id) const RecursiveExample = () => ( diff --git a/types/react-router/tslint.json b/types/react-router/tslint.json index 0209984d72..a773d31b69 100644 --- a/types/react-router/tslint.json +++ b/types/react-router/tslint.json @@ -1,8 +1,14 @@ { "extends": "../tslint.json", "rules": { + "align": false, + "array-type": false, + "eofline": false, + "no-consecutive-blank-lines": false, "no-empty-interface": false, + "prefer-method-signature": false, "void-return": false, - "no-single-declare-module": false + "no-single-declare-module": false, + "semicolon": false } } diff --git a/types/react-router/v3/lib/IndexRoute.d.ts b/types/react-router/v3/lib/IndexRoute.d.ts index 44b8c82919..9c82775c12 100644 --- a/types/react-router/v3/lib/IndexRoute.d.ts +++ b/types/react-router/v3/lib/IndexRoute.d.ts @@ -15,8 +15,8 @@ type ComponentsCallback = (err: any, components: RouteComponents) => any; export interface IndexRouteProps { component?: RouteComponent; components?: RouteComponents; - getComponent?: (nextState: RouterState, callback: ComponentCallback) => void; - getComponents?: (nextState: RouterState, callback: ComponentsCallback) => void; + getComponent?(nextState: RouterState, callback: ComponentCallback): void; + getComponents?(nextState: RouterState, callback: ComponentsCallback): void; onEnter?: EnterHook; onChange?: ChangeHook; onLeave?: LeaveHook; diff --git a/types/react-router/v3/lib/Route.d.ts b/types/react-router/v3/lib/Route.d.ts index 9063ac8b45..15aafebc75 100644 --- a/types/react-router/v3/lib/Route.d.ts +++ b/types/react-router/v3/lib/Route.d.ts @@ -25,7 +25,7 @@ type RoutesCallback = (err: any, routesArray: PlainRoute[]) => void; export interface PlainRoute extends RouteProps { childRoutes?: PlainRoute[]; - getChildRoutes?: (partialNextState: LocationState, callback: RoutesCallback) => void; + getChildRoutes?(partialNextState: LocationState, callback: RoutesCallback): void; indexRoute?: PlainRoute; - getIndexRoute?: (partialNextState: LocationState, callback: RouteCallback) => void; + getIndexRoute?(partialNextState: LocationState, callback: RouteCallback): void; } diff --git a/types/react-router/v3/lib/applyRouterMiddleware.d.ts b/types/react-router/v3/lib/applyRouterMiddleware.d.ts index e4d023a792..40872cd77a 100644 --- a/types/react-router/v3/lib/applyRouterMiddleware.d.ts +++ b/types/react-router/v3/lib/applyRouterMiddleware.d.ts @@ -2,8 +2,8 @@ import { RouteComponent } from "react-router"; import RouterContext from "react-router/lib/RouterContext"; export interface Middleware { - renderRouterContext?: (previous: RouterContext, props: any) => RouterContext; - renderRouteComponent?: (previous: RouteComponent, props: any) => RouteComponent; + renderRouterContext?(previous: RouterContext, props: any): RouterContext; + renderRouteComponent?(previous: RouteComponent, props: any): RouteComponent; } export default function applyRouterMiddleware(...middlewares: Middleware[]): (renderProps: any) => RouterContext; diff --git a/types/react-router/v3/react-router-tests.tsx b/types/react-router/v3/react-router-tests.tsx index 314c78c6ce..084b21ac22 100644 --- a/types/react-router/v3/react-router-tests.tsx +++ b/types/react-router/v3/react-router-tests.tsx @@ -49,7 +49,6 @@ interface MasterContext { } class Master extends Component { - static contextTypes: ValidationMap = { router: routerShape }; @@ -57,7 +56,7 @@ class Master extends Component { context: MasterContext; navigate() { - var router = this.context.router; + const router = this.context.router; router.push("/users"); router.push({ pathname: "/users/12", @@ -73,7 +72,6 @@ class Master extends Component {

    {this.props.children}

    ; } - } interface DashboardProps { @@ -84,7 +82,7 @@ class Dashboard extends React.Component { static staticMethodToBeHoisted(): void {} navigate() { - var router = this.props.router; + const router = this.props.router; router.push("/users"); router.push({ pathname: "/users/12", @@ -98,7 +96,6 @@ class Dashboard extends React.Component { This is a dashboard ; } - } const DashboardWithRouter = withRouter(Dashboard); @@ -106,29 +103,24 @@ const DashboardWithRouter = withRouter(Dashboard); DashboardWithRouter.staticMethodToBeHoisted(); class NotFound extends React.Component<{}, {}> { - render() { return
    This path does not exists
    ; } - } type UsersProps = RouteComponentProps<{}, {}>; class Users extends React.Component { - render() { const { location, params, route, routes, router, routeParams } = this.props; return
    This is a user list
    ; } - } - ReactDOM.render(( diff --git a/types/react-sidebar/index.d.ts b/types/react-sidebar/index.d.ts index a68749488c..1f3484762a 100644 --- a/types/react-sidebar/index.d.ts +++ b/types/react-sidebar/index.d.ts @@ -9,7 +9,7 @@ export interface SidebarProps { contentClassName?: string; docked?: boolean; dragToggleDistance?: number; - onSetOpen?: () => {}; + onSetOpen?(): {}; open?: boolean; overlayClassName?: string; pullRight?: boolean; diff --git a/types/react-smooth-scrollbar/index.d.ts b/types/react-smooth-scrollbar/index.d.ts index 6aea289136..54cc7d91b5 100644 --- a/types/react-smooth-scrollbar/index.d.ts +++ b/types/react-smooth-scrollbar/index.d.ts @@ -12,7 +12,7 @@ declare namespace Scrollbar { /** * Pipe to scrollbar.addListener() */ - onScroll?: (status: ScrollStatusObject, scrollbarInstance: SmoothScrollbar) => void; + onScroll?(status: ScrollStatusObject, scrollbarInstance: SmoothScrollbar): void; /** * Keep scrollbar tracks visible whether it's scrolling or not * @default false @@ -34,7 +34,6 @@ declare class Scrollbar extends React.Component { * Scrollbar instance */ readonly scrollbar: SmoothScrollbar; - } export as namespace Scrollbar; diff --git a/types/react-sticky/index.d.ts b/types/react-sticky/index.d.ts index 8c965da4ab..b83fa37ac4 100644 --- a/types/react-sticky/index.d.ts +++ b/types/react-sticky/index.d.ts @@ -16,7 +16,7 @@ export interface StickyProps { stickyStyle?: any; topOffset?: number; bottomOffset?: number; - onStickyStateChange?: (isSticky: boolean) => void; + onStickyStateChange?(isSticky: boolean): void; } export const Sticky: React.ComponentClass; diff --git a/types/react-test-renderer/index.d.ts b/types/react-test-renderer/index.d.ts index 9908394888..927e041378 100644 --- a/types/react-test-renderer/index.d.ts +++ b/types/react-test-renderer/index.d.ts @@ -16,7 +16,7 @@ interface ReactTestRendererJSON { $$typeof?: any; } interface TestRendererOptions { - createNodeMock: (element: ReactElement) => any; + createNodeMock(element: ReactElement): any; } // https://github.com/facebook/react/blob/master/src/renderers/testing/ReactTestMount.js#L155 export function create(nextElement: ReactElement, options?: TestRendererOptions): Renderer; diff --git a/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts b/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts new file mode 100644 index 0000000000..6cd9604575 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts @@ -0,0 +1 @@ +export * from '../es/ArrowKeyStepper'; diff --git a/types/react-virtualized/dist/commonjs/AutoSizer.d.ts b/types/react-virtualized/dist/commonjs/AutoSizer.d.ts new file mode 100644 index 0000000000..6d16fa0c45 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/AutoSizer.d.ts @@ -0,0 +1 @@ +export * from '../es/AutoSizer'; diff --git a/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts b/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts new file mode 100644 index 0000000000..77f4abea84 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts @@ -0,0 +1 @@ +export * from '../es/CellMeasurer'; diff --git a/types/react-virtualized/dist/commonjs/Collection.d.ts b/types/react-virtualized/dist/commonjs/Collection.d.ts new file mode 100644 index 0000000000..e4905c3eee --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Collection.d.ts @@ -0,0 +1 @@ +export * from '../es/Collection'; diff --git a/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts b/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts new file mode 100644 index 0000000000..1c42d3b94b --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts @@ -0,0 +1 @@ +export * from '../es/ColumnSizer'; diff --git a/types/react-virtualized/dist/commonjs/Grid.d.ts b/types/react-virtualized/dist/commonjs/Grid.d.ts new file mode 100644 index 0000000000..6834f9b47d --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Grid.d.ts @@ -0,0 +1 @@ +export * from '../es/Grid'; diff --git a/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts b/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts new file mode 100644 index 0000000000..d4614b32d7 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts @@ -0,0 +1 @@ +export * from '../es/InfiniteLoader'; diff --git a/types/react-virtualized/dist/commonjs/List.d.ts b/types/react-virtualized/dist/commonjs/List.d.ts new file mode 100644 index 0000000000..8a174d91e2 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/List.d.ts @@ -0,0 +1 @@ +export * from '../es/List'; diff --git a/types/react-virtualized/dist/commonjs/Masonry.d.ts b/types/react-virtualized/dist/commonjs/Masonry.d.ts new file mode 100644 index 0000000000..fc2768d7b7 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Masonry.d.ts @@ -0,0 +1 @@ +export * from '../es/Masonry'; diff --git a/types/react-virtualized/dist/commonjs/MultiGrid.d.ts b/types/react-virtualized/dist/commonjs/MultiGrid.d.ts new file mode 100644 index 0000000000..7504908682 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/MultiGrid.d.ts @@ -0,0 +1 @@ +export * from '../es/MultiGrid'; diff --git a/types/react-virtualized/dist/commonjs/ScrollSync.d.ts b/types/react-virtualized/dist/commonjs/ScrollSync.d.ts new file mode 100644 index 0000000000..2e9ec08a4d --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ScrollSync.d.ts @@ -0,0 +1 @@ +export * from '../es/ScrollSync'; diff --git a/types/react-virtualized/dist/commonjs/Table.d.ts b/types/react-virtualized/dist/commonjs/Table.d.ts new file mode 100644 index 0000000000..c710f4050c --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Table.d.ts @@ -0,0 +1 @@ +export * from '../es/Table'; diff --git a/types/react-virtualized/dist/commonjs/WindowScroller.d.ts b/types/react-virtualized/dist/commonjs/WindowScroller.d.ts new file mode 100644 index 0000000000..51cd1f6ac0 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/WindowScroller.d.ts @@ -0,0 +1 @@ +export * from '../es/WindowScroller'; diff --git a/types/react-virtualized/dist/es/ArrowKeyStepper.d.ts b/types/react-virtualized/dist/es/ArrowKeyStepper.d.ts new file mode 100644 index 0000000000..e42ff353f2 --- /dev/null +++ b/types/react-virtualized/dist/es/ArrowKeyStepper.d.ts @@ -0,0 +1,55 @@ +import { PropTypes, PureComponent, Validator, Requireable } from 'react' + +export type OnSectionRenderedParams = { + columnStartIndex: number, + columnStopIndex: number, + rowStartIndex: number, + rowStopIndex: number +} + +export type ChildProps = { + onSectionRendered: (params: OnSectionRenderedParams) => void, + scrollToColumn: number, + scrollToRow: number +}; +/** + * This HOC decorates a virtualized component and responds to arrow-key events by scrolling one row or column at a time. + */ +export type ArrowKeyStepperProps = { + children?: (props: ChildProps) => React.ReactNode; + className?: string; + columnCount: number; + rowCount: number; + mode?: 'edges' | 'cells'; +} +export type ScrollIndexes = { + scrollToRow: number, + scrollToColumn: number +} +export class ArrowKeyStepper extends PureComponent { + static defaultProps: { + disabled: false, + mode: 'edges', + scrollToColumn: 0, + scrollToRow: 0 + }; + + static propTypes: { + children: Validator<(props: ChildProps) => React.ReactNode>, + className: Requireable, + columnCount: Validator, + disabled: Validator, + mode: Validator<'cells' | 'edges'>, + rowCount: Validator, + scrollToColumn: Validator, + scrollToRow: Validator + }; + + constructor(props: ArrowKeyStepperProps, context: any); + + componentWillReceiveProps(nextProps: ArrowKeyStepperProps): void; + + setScrollIndexes(params: ScrollIndexes): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/AutoSizer.d.ts b/types/react-virtualized/dist/es/AutoSizer.d.ts new file mode 100644 index 0000000000..ea72c43c1e --- /dev/null +++ b/types/react-virtualized/dist/es/AutoSizer.d.ts @@ -0,0 +1,49 @@ +import { PropTypes, PureComponent, Validator, Requireable } from 'react' + +export type Dimensions = { + height: number, + width: number +} + +export type AutoSizerProps = { + disableHeight?: boolean; + disableWidth?: boolean; + onResize?: (info: { height: number, width: number }) => any; + children?: (props: Dimensions) => React.ReactNode +}; +/** + * Decorator component that automatically adjusts the width and height of a single child. + * Child component should not be declared as a child but should rather be specified by a `ChildComponent` property. + * All other properties will be passed through to the child component. + */ +export class AutoSizer extends PureComponent { + static propTypes: { + /** + * Function responsible for rendering children. + * This function should implement the following signature: + * ({ height, width }) => PropTypes.element + */ + children: Validator<(props: Dimensions) => React.ReactNode>, + + /** Disable dynamic :height property */ + disableHeight: Requireable, + + /** Disable dynamic :width property */ + disableWidth: Requireable, + + /** Callback to be invoked on-resize: ({ height, width }) */ + onResize: Validator<(props: Dimensions) => any> + }; + + static defaultProps: { + onResize: () => {} + }; + + constructor(props: AutoSizerProps); + + componentDidMount(): void; + + componentWillUnmount(): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/CellMeasurer.d.ts b/types/react-virtualized/dist/es/CellMeasurer.d.ts new file mode 100644 index 0000000000..5e1e0db3fb --- /dev/null +++ b/types/react-virtualized/dist/es/CellMeasurer.d.ts @@ -0,0 +1,78 @@ +import { PureComponent } from 'react' + +export type KeyMapper = ( + rowIndex: number, + columnIndex: number +) => any; + +export type CellMeasurerCacheParams = { + defaultHeight?: number, + defaultWidth?: number, + fixedHeight?: boolean, + fixedWidth?: boolean, + minHeight?: number, + minWidth?: number, + keyMapper?: KeyMapper +} +export class CellMeasurerCache { + constructor(params: CellMeasurerCacheParams); + clear( + rowIndex: number, + columnIndex: number + ): void; + clearAll(): void; + columnWidth: (params: { index: number }) => number | undefined; + hasFixedHeight(): boolean; + hasFixedWidth(): boolean; + getHeight( + rowIndex: number, + columnIndex: number + ): number | undefined; + getWidth( + rowIndex: number, + columnIndex: number + ): number | undefined; + has( + rowIndex: number, + columnIndex: number + ): boolean; + rowHeight: (params: { index: number }) => number | undefined; + set( + rowIndex: number, + columnIndex: number, + width: number, + height: number + ): void; +} + +export type CellMeasurerChildProps = { + getColumnWidth: () => number, + getRowHeight: () => number, + resetMeasurements: () => any, + resetMeasurementsForColumn: (index: number) => any, + resetMeasurementsForRow: (index: number) => any, +} + +export type CellMeasurerProps = { + cache?: CellMeasurerCache; + children?: (props: CellMeasurerChildProps) => React.ReactNode; + columnIndex?: number; + index?: number; + parent?: React.ReactType; + rowIndex?: number; + style?: React.CSSProperties; +} +/** + * Wraps a cell and measures its rendered content. + * Measurements are stored in a per-cell cache. + * Cached-content is not be re-measured. + */ +export class CellMeasurer extends PureComponent { + constructor(props: CellMeasurerProps, context: any); + + componentDidMount(): void; + + componentDidUpdate(prevProps: CellMeasurerProps, prevState: any): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/Collection.d.ts b/types/react-virtualized/dist/es/Collection.d.ts new file mode 100644 index 0000000000..404d329222 --- /dev/null +++ b/types/react-virtualized/dist/es/Collection.d.ts @@ -0,0 +1,123 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { + Index, + ScrollPosition, + SizeInfo, + SizeAndPositionInfo +} from '../../index'; + +export type CollectionCellSizeAndPosition = { height: number, width: number, x: number, y: number }; +export type CollectionCellSizeAndPositionGetter = (params: Index) => CollectionCellSizeAndPosition; + +export type CollectionCellGroupRendererParams = { + cellSizeAndPositionGetter: CollectionCellSizeAndPositionGetter, + indices: number[], + cellRenderer: CollectionCellRenderer +} +export type CollectionCellGroupRenderer = (params: CollectionCellGroupRendererParams) => React.ReactNode[]; +export type CollectionCellRendererParams = { + index: number, + key: string, + style?: React.CSSProperties +} +export type CollectionCellRenderer = (params: CollectionCellRendererParams) => React.ReactNode; +export type CollectionProps = { + 'aria-label'?: string; + cellCount: number; + cellGroupRenderer?: CollectionCellGroupRenderer, + cellRenderer: CollectionCellRenderer, + cellSizeAndPositionGetter: CollectionCellSizeAndPositionGetter, + sectionSize?: number; + className?: string; + height: number; + width: number; + horizontalOverscanSize?: number; + noContentRenderer?: () => JSX.Element; + scrollToCell?: number; + verticalOverscanSize?: number; +}; + +/** + * Renders scattered or non-linear data. + * Unlike Grid, which renders checkerboard data, Collection can render arbitrarily positioned- even overlapping- data. + */ +export class Collection extends PureComponent { + static propTypes: { + 'aria-label': Requireable, + + /** + * Number of cells in Collection. + */ + cellCount: Validator, + + /** + * Responsible for rendering a group of cells given their indices. + * Should implement the following interface: ({ + * cellSizeAndPositionGetter:Function, + * indices: Array, + * cellRenderer: Function + * }): Array + */ + cellGroupRenderer: Validator, + + /** + * Responsible for rendering a cell given an row and column index. + * Should implement the following interface: ({ index: number, key: string, style: object }): PropTypes.element + */ + cellRenderer: Validator, + + /** + * Callback responsible for returning size and offset/position information for a given cell (index). + * ({ index: number }): { height: number, width: number, x: number, y: number } + */ + cellSizeAndPositionGetter: Validator, + + /** + * Optionally override the size of the sections a Collection's cells are split into. + */ + sectionSize: Requireable + }; + + static defaultProps: { + 'aria-label': 'grid', + cellGroupRenderer: CollectionCellGroupRenderer + }; + + constructor(props: CollectionProps, context: any); + + forceUpdate(): void; + + /** See Collection#recomputeCellSizesAndPositions */ + recomputeCellSizesAndPositions(): void; + + /** React lifecycle methods */ + + render(): JSX.Element; + + /** CellLayoutManager interface */ + + calculateSizeAndPositionData(): void; + + /** + * Returns the most recently rendered set of cell indices. + */ + getLastRenderedIndices(): number[]; + + /** + * Calculates the minimum amount of change from the current scroll position to ensure the specified cell is (fully) visible. + */ + getScrollPositionForCell(params: { + align: 'auto' | 'start' | 'end' | 'center', + cellIndex: number, + height: number, + scrollLeft: number, + scrollTop: number, + width: number + }): ScrollPosition; + + getTotalSize(): SizeInfo; + + cellRenderers(params: { + isScrolling: boolean, + } & SizeInfo): React.ReactNode[]; +} diff --git a/types/react-virtualized/dist/es/ColumnSizer.d.ts b/types/react-virtualized/dist/es/ColumnSizer.d.ts new file mode 100644 index 0000000000..6efcf8c044 --- /dev/null +++ b/types/react-virtualized/dist/es/ColumnSizer.d.ts @@ -0,0 +1,50 @@ +import { PureComponent, Validator, Requireable } from 'react' + +export type SizedColumnProps = { + adjustedWidth: number, + getColumnWidth: () => number, + registerChild: any +} + +export type ColumnSizerProps = { + children?: (props: SizedColumnProps) => React.ReactNode; + columnMaxWidth?: number; + columnMinWidth?: number; + columnCount?: number; + width: number; +} +/** + * High-order component that auto-calculates column-widths for `Grid` cells. + */ +export class ColumnSizer extends PureComponent { + static propTypes: { + /** + * Function responsible for rendering a virtualized Grid. + * This function should implement the following signature: + * ({ adjustedWidth, getColumnWidth, registerChild }) => PropTypes.element + * + * The specified :getColumnWidth function should be passed to the Grid's :columnWidth property. + * The :registerChild should be passed to the Grid's :ref property. + * The :adjustedWidth property is optional; it reflects the lesser of the overall width or the width of all columns. + */ + children: Validator<(props: SizedColumnProps) => React.ReactNode>, + + /** Optional maximum allowed column width */ + columnMaxWidth: Requireable, + + /** Optional minimum allowed column width */ + columnMinWidth: Requireable, + + /** Number of columns in Grid or Table child */ + columnCount: Validator, + + /** Width of Grid or Table child */ + width: Validator + }; + + constructor(props: ColumnSizerProps, context: any); + + componentDidUpdate(prevProps: ColumnSizerProps, prevState: any): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/Grid.d.ts b/types/react-virtualized/dist/es/Grid.d.ts new file mode 100644 index 0000000000..7fcd0d1314 --- /dev/null +++ b/types/react-virtualized/dist/es/Grid.d.ts @@ -0,0 +1,461 @@ +import { Validator, Requireable, PureComponent } from 'react' +import { List } from './List'; +import { Table } from './Table'; +import { CellMeasurerCache } from './CellMeasurer'; +import { Index, Map, Alignment } from '../../index'; + +export type GridCellProps = { + columnIndex: number; + isScrolling: boolean; + isVisible: boolean; + key: string; + parent: Grid | List | Table; + rowIndex: number; + style: React.CSSProperties; +}; +export type GridCellRenderer = (props: GridCellProps) => React.ReactNode; + +export type ConfigureParams = { + cellCount: number, + estimatedCellSize: number +}; +export type ContainerSizeAndOffset = { + containerSize: number, + offset: number +}; +export type SizeAndPositionData = { + offset: number, + size: number +}; +export type GetVisibleCellRangeParams = { + containerSize: number, + offset: number +}; +export type VisibleCellRange = { + start: number; + stop: number; +}; +export type ScrollParams = { + clientHeight: number, + clientWidth: number, + scrollHeight: number, + scrollLeft: number, + scrollTop: number, + scrollWidth: number +}; +export type SectionRenderedParams = { + columnStartIndex: number, + columnStopIndex: number, + rowStartIndex: number, + rowStopIndex: number +}; +export type OverscanIndicesGetterParams = { + cellCount: number, + overscanCellsCount: number, + scrollDirection: number, + startIndex: number, + stopIndex: number +}; +export type OverscanIndices = { + overscanStartIndex: number, + overscanStopIndex: number +}; + +export type CellSizeAndPositionManager = { + areOffsetsAdjusted(): boolean; + configure({ + cellCount, + estimatedCellSize + }: ConfigureParams): void; + getCellCount(): number; + getEstimatedCellSize(): number; + getLastMeasuredIndex(): number; + getOffsetAdjustment({ + containerSize, + offset // safe + }: ContainerSizeAndOffset): number; + /** + * This method returns the size and position for the cell at the specified index. + * It just-in-time calculates (or used cached values) for cells leading up to the index. + */ + getSizeAndPositionOfCell(index: number): SizeAndPositionData; + getSizeAndPositionOfLastMeasuredCell(): SizeAndPositionData; + /** + * Total size of all cells being measured. + * This value will be completedly estimated initially. + * As cells as measured the estimate will be updated. + */ + getTotalSize(): number; + /** + * Determines a new offset that ensures a certain cell is visible, given the current offset. + * If the cell is already visible then the current offset will be returned. + * If the current offset is too great or small, it will be adjusted just enough to ensure the specified index is visible. + * + * @param align Desired alignment within container; one of "auto" (default), "start", or "end" + * @param containerSize Size (width or height) of the container viewport + * @param currentOffset Container's current (x or y) offset + * @param totalSize Total size (width or height) of all cells + * @return Offset to use to ensure the specified cell is visible + */ + getUpdatedOffsetForIndex(params: { + align: string, + containerSize: number, + currentOffset: number, + targetIndex: number + }): number; + getVisibleCellRange(params: GetVisibleCellRangeParams): VisibleCellRange; + /** + * Clear all cached values for cells after the specified index. + * This method should be called for any cell that has changed its size. + * It will not immediately perform any calculations; they'll be performed the next time getSizeAndPositionOfCell() is called. + */ + resetCell(index: number): void +} + +export type GridCellRangeProps = { + cellCache: Map, + cellRenderer: GridCellRenderer, + columnSizeAndPositionManager: CellSizeAndPositionManager, + columnStartIndex: number, + columnStopIndex: number, + isScrolling: boolean, + rowSizeAndPositionManager: CellSizeAndPositionManager, + rowStartIndex: number, + rowStopIndex: number, + scrollLeft: number, + scrollTop: number +} +export type GridCellRangeRenderer = (params: GridCellRangeProps) => React.ReactNode[]; +// TODO add proper typing +export type GridProps = { + 'aria-label'?: string; + autoContainerWidth?: boolean; + autoHeight?: boolean; + cellRenderer: GridCellRenderer; + cellRangeRenderer?: GridCellRangeRenderer; + className?: string; + columnCount: number; + columnWidth: number | ((params: Index) => number); + containerStyle?: React.CSSProperties; + deferredMeasurementCache?: CellMeasurerCache; + estimatedColumnSize?: number; + estimatedRowSize?: number; + getScrollbarSize?: () => number; + height: number; + id?: string; + noContentRenderer?: () => React.ReactNode; + onScroll?: (params: ScrollParams) => any; + onSectionRendered?: (params: SectionRenderedParams) => any; + overscanColumnCount?: number; + overscanIndicesGetter?: (params: OverscanIndicesGetterParams) => OverscanIndices; + overscanRowCount?: number; + rowHeight: number | ((params: Index) => number); + rowCount: number; + scrollingResetTimeInterval?: number; + scrollLeft?: number; + scrollToAlignment?: Alignment; + scrollToColumn?: number; + scrollTop?: number; + scrollToRow?: number; + style?: React.CSSProperties; + tabIndex?: number; + width: number; +}; + +export type ScrollDirection = 'horizontal' | 'vertical'; + +export type GridState = { + isScrolling: boolean, + scrollDirectionHorizontal: ScrollDirection, + scrollDirectionVertical: ScrollDirection, + scrollLeft: number, + scrollTop: number +}; + +/** + * Specifies the number of miliseconds during which to disable pointer events while a scroll is in progress. + * This improves performance and makes scrolling smoother. + */ +export const DEFAULT_SCROLLING_RESET_TIME_INTERVAL = 150 + +/** + * Renders tabular data with virtualization along the vertical and horizontal axes. + * Row heights and column widths must be known ahead of time and specified as properties. + */ +export class Grid extends PureComponent { + static propTypes: { + 'aria-label': Requireable, + + /** + * Set the width of the inner scrollable container to 'auto'. + * This is useful for single-column Grids to ensure that the column doesn't extend below a vertical scrollbar. + */ + autoContainerWidth: Requireable, + + /** + * Removes fixed height from the scrollingContainer so that the total height + * of rows can stretch the window. Intended for use with WindowScroller + */ + autoHeight: Requireable, + + /** + * Responsible for rendering a cell given an row and column index. + * Should implement the following interface: ({ columnIndex: number, rowIndex: number }): PropTypes.node + */ + cellRenderer: Validator<(props: GridCellProps) => React.ReactNode>, + + /** + * Responsible for rendering a group of cells given their index ranges. + * Should implement the following interface: ({ + * cellCache: Map, + * cellRenderer: Function, + * columnSizeAndPositionManager: CellSizeAndPositionManager, + * columnStartIndex: number, + * columnStopIndex: number, + * isScrolling: boolean, + * rowSizeAndPositionManager: CellSizeAndPositionManager, + * rowStartIndex: number, + * rowStopIndex: number, + * scrollLeft: number, + * scrollTop: number + * }): Array + */ + cellRangeRenderer: Validator<(params: GridCellRangeProps) => React.ReactNode[]>, + + /** + * Optional custom CSS class name to attach to root Grid element. + */ + className: Requireable, + + /** + * Number of columns in grid. + */ + columnCount: Validator, + + /** + * Either a fixed column width (number) or a function that returns the width of a column given its index. + * Should implement the following interface: (index: number): number + */ + columnWidth: Validator number)>, + + /** Optional inline style applied to inner cell-container */ + containerStyle: Requireable, + + /** + * If CellMeasurer is used to measure this Grid's children, this should be a pointer to its CellMeasurerCache. + * A shared CellMeasurerCache reference enables Grid and CellMeasurer to share measurement data. + */ + deferredMeasurementCache: Requireable, + + /** + * Used to estimate the total width of a Grid before all of its columns have actually been measured. + * The estimated total width is adjusted as columns are rendered. + */ + estimatedColumnSize: Validator, + + /** + * Used to estimate the total height of a Grid before all of its rows have actually been measured. + * The estimated total height is adjusted as rows are rendered. + */ + estimatedRowSize: Validator, + + /** + * Exposed for testing purposes only. + */ + getScrollbarSize: Validator<() => number>, + + /** + * Height of Grid; this property determines the number of visible (vs virtualized) rows. + */ + height: Validator, + + /** + * Optional custom id to attach to root Grid element. + */ + id: Requireable, + + /** + * Optional renderer to be used in place of rows when either :rowCount or :columnCount is 0. + */ + noContentRenderer: Requireable<() => JSX.Element>, + + /** + * Callback invoked whenever the scroll offset changes within the inner scrollable region. + * This callback can be used to sync scrolling between lists, tables, or grids. + * ({ clientHeight, clientWidth, scrollHeight, scrollLeft, scrollTop, scrollWidth }): void + */ + onScroll: Validator<(params: ScrollParams) => void>, + + /** + * Callback invoked with information about the section of the Grid that was just rendered. + * ({ columnStartIndex, columnStopIndex, rowStartIndex, rowStopIndex }): void + */ + onSectionRendered: Validator<(params: SectionRenderedParams) => void>, + + /** + * Number of columns to render before/after the visible section of the grid. + * These columns can help for smoother scrolling on touch devices or browsers that send scroll events infrequently. + */ + overscanColumnCount: Validator, + + /** + * Calculates the number of cells to overscan before and after a specified range. + * This function ensures that overscanning doesn't exceed the available cells. + * Should implement the following interface: ({ + * cellCount: number, + * overscanCellsCount: number, + * scrollDirection: number, + * startIndex: number, + * stopIndex: number + * }): {overscanStartIndex: number, overscanStopIndex: number} + */ + overscanIndicesGetter: Validator<(params: OverscanIndicesGetterParams) => OverscanIndices>, + + /** + * Number of rows to render above/below the visible section of the grid. + * These rows can help for smoother scrolling on touch devices or browsers that send scroll events infrequently. + */ + overscanRowCount: Validator, + + /** + * ARIA role for the grid element. + */ + role: Requireable, + + /** + * Either a fixed row height (number) or a function that returns the height of a row given its index. + * Should implement the following interface: ({ index: number }): number + */ + rowHeight: Validator number)>, + + /** + * Number of rows in grid. + */ + rowCount: Validator, + + /** Wait this amount of time after the last scroll event before resetting Grid `pointer-events`. */ + scrollingResetTimeInterval: Requireable, + + /** Horizontal offset. */ + scrollLeft: Requireable, + + /** + * Controls scroll-to-cell behavior of the Grid. + * The default ("auto") scrolls the least amount possible to ensure that the specified cell is fully visible. + * Use "start" to align cells to the top/left of the Grid and "end" to align bottom/right. + */ + scrollToAlignment: Validator, + + /** + * Column index to ensure visible (by forcefully scrolling if necessary) + */ + scrollToColumn: Validator, + + /** Vertical offset. */ + scrollTop: Requireable, + + /** + * Row index to ensure visible (by forcefully scrolling if necessary) + */ + scrollToRow: Validator, + + /** Optional inline style */ + style: Requireable, + + /** Tab index for focus */ + tabIndex: Requireable, + + /** + * Width of Grid; this property determines the number of visible (vs virtualized) columns. + */ + width: Validator + }; + + static defaultProps: { + 'aria-label': 'grid', + cellRangeRenderer: GridCellRangeRenderer, + estimatedColumnSize: 100, + estimatedRowSize: 30, + getScrollbarSize: () => number, + noContentRenderer: () => null, + onScroll: () => null, + onSectionRendered: () => null, + overscanColumnCount: 0, + overscanIndicesGetter: OverscanIndicesGetterParams, + overscanRowCount: 10, + role: 'grid', + scrollingResetTimeInterval: typeof DEFAULT_SCROLLING_RESET_TIME_INTERVAL, + scrollToAlignment: 'auto', + scrollToColumn: -1, + scrollToRow: -1, + style: {}, + tabIndex: 0 + }; + + constructor(props: GridProps, context: any); + + /** + * Invalidate Grid size and recompute visible cells. + * This is a deferred wrapper for recomputeGridSize(). + * It sets a flag to be evaluated on cDM/cDU to avoid unnecessary renders. + * This method is intended for advanced use-cases like CellMeasurer. + */ + // @TODO (bvaughn) Add automated test coverage for this. + invalidateCellSizeAfterRender(params: { + columnIndex: number, + rowIndex: number + }): void + + /** + * Pre-measure all columns and rows in a Grid. + * Typically cells are only measured as needed and estimated sizes are used for cells that have not yet been measured. + * This method ensures that the next call to getTotalSize() returns an exact size (as opposed to just an estimated one). + */ + measureAllCells(): void; + + /** + * Forced recompute of row heights and column widths. + * This function should be called if dynamic column or row sizes have changed but nothing else has. + * Since Grid only receives :columnCount and :rowCount it has no way of detecting when the underlying data changes. + */ + recomputeGridSize(params?: { + columnIndex?: number, + rowIndex?: number + }): void; + + /** + * Ensure column and row are visible. + */ + scrollToCell(params: { + columnIndex: number, + rowIndex: number + }): void; + + componentDidMount(): void; + + /** + * @private + * This method updates scrollLeft/scrollTop in state for the following conditions: + * 1) New scroll-to-cell props have been set + */ + componentDidUpdate(prevProps: GridProps, prevState: GridState): void; + + componentWillMount(): void; + + componentWillUnmount(): void; + + /** + * @private + * This method updates scrollLeft/scrollTop in state for the following conditions: + * 1) Empty content (0 rows or columns) + * 2) New scroll props overriding the current state + * 3) Cells-count or cells-size has changed, making previous scroll offsets invalid + */ + componentWillReceiveProps(nextProps: GridProps): void; + + componentWillUpdate(nextProps: GridProps, nextState: GridState): void; + + render(): JSX.Element; +} + +export const defaultCellRangeRenderer: GridCellRangeRenderer; diff --git a/types/react-virtualized/dist/es/InfiniteLoader.d.ts b/types/react-virtualized/dist/es/InfiniteLoader.d.ts new file mode 100644 index 0000000000..e16359adca --- /dev/null +++ b/types/react-virtualized/dist/es/InfiniteLoader.d.ts @@ -0,0 +1,80 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { Index, IndexRange } from '../../index'; + +export type InfiniteLoaderChildProps = { + onRowsRendered: (params: { startIndex: number, stopIndex: number }) => void, + registerChild: (registeredChild: any) => void +} + +export type InfiniteLoaderProps = { + children?: (props: InfiniteLoaderChildProps) => React.ReactNode; + isRowLoaded: (params: Index) => boolean; + loadMoreRows: (params: IndexRange) => Promise; + minimumBatchSize?: number; + rowCount?: number; + threshold?: number; +}; + +/** + * Higher-order component that manages lazy-loading for "infinite" data. + * This component decorates a virtual component and just-in-time prefetches rows as a user scrolls. + * It is intended as a convenience component; fork it if you'd like finer-grained control over data-loading. + */ +export class InfiniteLoader extends PureComponent { + static propTypes: { + /** + * Function responsible for rendering a virtualized component. + * This function should implement the following signature: + * ({ onRowsRendered, registerChild }) => PropTypes.element + * + * The specified :onRowsRendered function should be passed through to the child's :onRowsRendered property. + * The :registerChild callback should be set as the virtualized component's :ref. + */ + children: Validator<(props: InfiniteLoaderChildProps) => React.ReactNode>, + + /** + * Function responsible for tracking the loaded state of each row. + * It should implement the following signature: ({ index: number }): boolean + */ + isRowLoaded: Validator<(params: Index) => boolean>, + + /** + * Callback to be invoked when more rows must be loaded. + * It should implement the following signature: ({ startIndex, stopIndex }): Promise + * The returned Promise should be resolved once row data has finished loading. + * It will be used to determine when to refresh the list with the newly-loaded data. + * This callback may be called multiple times in reaction to a single scroll event. + */ + loadMoreRows: Validator<(params: IndexRange) => Promise>, + + /** + * Minimum number of rows to be loaded at a time. + * This property can be used to batch requests to reduce HTTP requests. + */ + minimumBatchSize: Validator, + + /** + * Number of rows in list; can be arbitrary high number if actual number is unknown. + */ + rowCount: Validator, + + /** + * Threshold at which to pre-fetch data. + * A threshold X means that data will start loading when a user scrolls within X rows. + * This value defaults to 15. + */ + threshold: Validator + }; + + static defaultProps: { + minimumBatchSize: 10, + rowCount: 0, + threshold: 15 + }; + + constructor(props: InfiniteLoaderProps, context: any); + + resetLoadMoreRowsCache(): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/List.d.ts b/types/react-virtualized/dist/es/List.d.ts new file mode 100644 index 0000000000..2a4f30dbfe --- /dev/null +++ b/types/react-virtualized/dist/es/List.d.ts @@ -0,0 +1,137 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { Grid, GridCellProps } from './Grid' +import { Index, IndexRange, Alignment } from '../../index' +import { CellMeasurerCache } from './CellMeasurer' + +export type ListRowProps = GridCellProps & { index: number, style: React.CSSProperties }; + +export type ListRowRenderer = (props: ListRowProps) => React.ReactNode; +export type ListProps = { + deferredMeasurementCache?: CellMeasurerCache; + className?: string; + autoHeight?: boolean; + estimatedRowSize?: number; + height: number; + noRowsRenderer?: () => JSX.Element; + onRowsRendered?: (info: { overscanStartIndex: number, overscanStopIndex: number, startIndex: number, stopIndex: number }) => void; + onScroll?: (info: { clientHeight: number, scrollHeight: number, scrollTop: number }) => void; + overscanRowCount?: number; + rowHeight: number | ((info: Index) => number); + rowRenderer: ListRowRenderer; + rowCount: number; + scrollToAlignment?: string; + scrollToIndex?: number; + scrollTop?: number; + style?: React.CSSProperties; + tabIndex?: number; + width: number; +} +/** + * It is inefficient to create and manage a large list of DOM elements within a scrolling container + * if only a few of those elements are visible. The primary purpose of this component is to improve + * performance by only rendering the DOM nodes that a user is able to see based on their current + * scroll position. + * + * This component renders a virtualized list of elements with either fixed or dynamic heights. + */ +export class List extends PureComponent { + static propTypes: { + 'aria-label': Requireable, + + /** + * Removes fixed height from the scrollingContainer so that the total height + * of rows can stretch the window. Intended for use with WindowScroller + */ + autoHeight: Requireable, + + /** Optional CSS class name */ + className: Requireable, + + /** + * Used to estimate the total height of a List before all of its rows have actually been measured. + * The estimated total height is adjusted as rows are rendered. + */ + estimatedRowSize: Validator, + + /** Height constraint for list (determines how many actual rows are rendered) */ + height: Validator, + + /** Optional renderer to be used in place of rows when rowCount is 0 */ + noRowsRenderer: Validator<() => JSX.Element>, + + /** + * Callback invoked with information about the slice of rows that were just rendered. + * ({ startIndex, stopIndex }): void + */ + onRowsRendered: Validator<(params: IndexRange) => void>, + + /** + * Number of rows to render above/below the visible bounds of the list. + * These rows can help for smoother scrolling on touch devices. + */ + overscanRowCount: Validator, + + /** + * Callback invoked whenever the scroll offset changes within the inner scrollable region. + * This callback can be used to sync scrolling between lists, tables, or grids. + * ({ clientHeight, scrollHeight, scrollTop }): void + */ + onScroll: Validator<(params: { clientHeight: number, scrollHeight: number, scrollTop: number }) => void>, + + /** + * Either a fixed row height (number) or a function that returns the height of a row given its index. + * ({ index: number }): number + */ + rowHeight: Validator number)>, + + /** Responsible for rendering a row given an index; ({ index: number }): node */ + rowRenderer: Validator, + + /** Number of rows in list. */ + rowCount: Validator, + + /** See Grid#scrollToAlignment */ + scrollToAlignment: Validator, + + /** Row index to ensure visible (by forcefully scrolling if necessary) */ + scrollToIndex: Validator, + + /** Vertical offset. */ + scrollTop: Requireable, + + /** Optional inline style */ + style: Validator, + + /** Tab index for focus */ + tabIndex: Requireable, + + /** Width of list */ + width: Validator + }; + + static defaultProps: { + estimatedRowSize: 30, + noRowsRenderer: () => null, + onRowsRendered: () => null, + onScroll: () => null, + overscanRowCount: 10, + scrollToAlignment: 'auto', + scrollToIndex: -1, + style: {} + }; + + constructor(props: ListProps, context: any); + + forceUpdateGrid(): void; + + /** See Grid#measureAllCells */ + measureAllRows(): void; + + /** See Grid#recomputeGridSize */ + recomputeRowHeights(index?: number): void; + + /** See Grid#scrollToCell */ + scrollToRow(index?: number): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/Masonry.d.ts b/types/react-virtualized/dist/es/Masonry.d.ts new file mode 100644 index 0000000000..eb44635978 --- /dev/null +++ b/types/react-virtualized/dist/es/Masonry.d.ts @@ -0,0 +1,144 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { CellMeasurerCache, KeyMapper } from './CellMeasurer'; +import { GridCellRenderer } from './Grid'; +/** + * Specifies the number of miliseconds during which to disable pointer events while a scroll is in progress. + * This improves performance and makes scrolling smoother. + */ +export const DEFAULT_SCROLLING_RESET_TIME_INTERVAL = 150 + +export type OnCellsRenderedCallback = (params: { + startIndex: number, + stopIndex: number +}) => void; + +export type OnScrollCallback = (params: { + clientHeight: number, + scrollHeight: number, + scrollTop: number +}) => void; + +export type MasonryCellProps = { + index: number, + isScrolling: boolean, + key: React.Key, + parent: React.ReactType, + style?: React.CSSProperties +} + +export type CellRenderer = (props: MasonryCellProps) => React.ReactNode + +export type MasonryProps = { + autoHeight: boolean, + cellCount: number, + cellMeasurerCache: CellMeasurerCache, + cellPositioner: Positioner, + cellRenderer: CellRenderer, + className?: string, + height: number, + id?: string, + keyMapper?: KeyMapper, + onCellsRendered?: OnCellsRenderedCallback, + onScroll?: OnScrollCallback, + overscanByPixels?: number, + role?: string, + scrollingResetTimeInterval?: number, + scrollTop?: number, + style?: React.CSSProperties, + tabIndex?: number, + width: number +} + +export type MasonryState = { + isScrolling: boolean, + scrollTop: number +} + +/** + * This component efficiently displays arbitrarily positioned cells using windowing techniques. + * Cell position is determined by an injected `cellPositioner` property. + * Windowing is vertical; this component does not support horizontal scrolling. + * + * Rendering occurs in two phases: + * 1) First pass uses estimated cell sizes (provided by the cache) to determine how many cells to measure in a batch. + * Batch size is chosen using a fast, naive layout algorithm that stacks images in order until the viewport has been filled. + * After measurement is complete (componentDidMount or componentDidUpdate) this component evaluates positioned cells + * in order to determine if another measurement pass is required (eg if actual cell sizes were less than estimated sizes). + * All measurements are permanently cached (keyed by `keyMapper`) for performance purposes. + * 2) Second pass uses the external `cellPositioner` to layout cells. + * At this time the positioner has access to cached size measurements for all cells. + * The positions it returns are cached by Masonry for fast access later. + * Phase one is repeated if the user scrolls beyond the current layout's bounds. + * If the layout is invalidated due to eg a resize, cached positions can be cleared using `recomputeCellPositions()`. + * + * Animation constraints: + * Simple animations are supported (eg translate/slide into place on initial reveal). + * More complex animations are not (eg flying from one position to another on resize). + * + * Layout constraints: + * This component supports multi-column layout. + * The height of each item may vary. + * The width of each item must not exceed the width of the column it is "in". + * The left position of all items within a column must align. + * (Items may not span multiple columns.) + */ +export class Masonry extends PureComponent { + static defaultProps: { + autoHeight: false, + keyMapper: identity, + onCellsRendered: noop, + onScroll: noop, + overscanByPixels: 20, + role: 'grid', + scrollingResetTimeInterval: typeof DEFAULT_SCROLLING_RESET_TIME_INTERVAL, + style: emptyObject, + tabIndex: 0 + } + + constructor(props: MasonryProps, context: any); + + clearCellPositions(): void; + + // HACK This method signature was intended for Grid + invalidateCellSizeAfterRender(params: { rowIndex: number }): void + + recomputeCellPositions(): void; + + componentDidMount(): void; + + componentDidUpdate(prevProps: MasonryProps, prevState: MasonryState): void; + + componentWillUnmount(): void; + + componentWillReceiveProps(nextProps: MasonryProps): void; + + render(): JSX.Element; +} + +type emptyObject = {} + +type identity = (value: T) => T; + +type noop = () => void; + +export type Position = { + left: number, + top: number +}; + +export type createCellPositionerParams = { + cellMeasurerCache: CellMeasurerCache, + columnCount: number, + columnWidth: number, + spacer?: number +}; + +export type resetParams = { + columnCount: number, + columnWidth: number, + spacer?: number +}; + +export type Positioner = ((index: number) => Position) & { reset: (params: resetParams) => void }; + +export const createCellPositioner: (params: createCellPositionerParams) => Positioner; diff --git a/types/react-virtualized/dist/es/MultiGrid.d.ts b/types/react-virtualized/dist/es/MultiGrid.d.ts new file mode 100644 index 0000000000..1bb8b7dfac --- /dev/null +++ b/types/react-virtualized/dist/es/MultiGrid.d.ts @@ -0,0 +1,75 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { GridProps } from './Grid' + +export type MultiGridProps = { + fixedColumnCount: number; + fixedRowCount: number; + style: React.CSSProperties; + styleBottomLeftGrid: React.CSSProperties; + styleBottomRightGrid: React.CSSProperties; + styleTopLeftGrid: React.CSSProperties; + styleTopRightGrid: React.CSSProperties; +} & GridProps; + +export type MultiGridState = { + scrollLeft: number, + scrollTop: number +} + +/** + * Renders 1, 2, or 4 Grids depending on configuration. + * A main (body) Grid will always be rendered. + * Optionally, 1-2 Grids for sticky header rows will also be rendered. + * If no sticky columns, only 1 sticky header Grid will be rendered. + * If sticky columns, 2 sticky header Grids will be rendered. + */ +export class MultiGrid extends PureComponent { + static propTypes: { + fixedColumnCount: Validator, + fixedRowCount: Validator, + style: Validator, + styleBottomLeftGrid: Validator, + styleBottomRightGrid: Validator, + styleTopLeftGrid: Validator, + styleTopRightGrid: Validator + }; + + static defaultProps: { + fixedColumnCount: 0, + fixedRowCount: 0, + style: {}, + styleBottomLeftGrid: {}, + styleBottomRightGrid: {}, + styleTopLeftGrid: {}, + styleTopRightGrid: {} + }; + + constructor(props: MultiGridProps, context: any); + + forceUpdateGrids(): void; + + /** See Grid#invalidateCellSizeAfterRender */ + invalidateCellSizeAfterRender(params?: { + columnIndex?: number, + rowIndex?: number + }): void; + + /** See Grid#measureAllCells */ + measureAllCells(): void; + + /** See Grid#recomputeGridSize */ + recomputeGridSize(params?: { + columnIndex?: number, + rowIndex?: number + }): void; + + componentDidMount(): void; + + componentDidUpdate(prevProps: MultiGridProps, prevState: MultiGridState): void; + + componentWillMount(): void; + + componentWillReceiveProps(nextProps: MultiGridProps, nextState: MultiGridState): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/ScrollSync.d.ts b/types/react-virtualized/dist/es/ScrollSync.d.ts new file mode 100644 index 0000000000..d244262d25 --- /dev/null +++ b/types/react-virtualized/dist/es/ScrollSync.d.ts @@ -0,0 +1,51 @@ +import { PureComponent, Validator, Requireable } from 'react' + +export type OnScrollParams = { + clientHeight: number, + clientWidth: number, + scrollHeight: number, + scrollLeft: number, + scrollTop: number, + scrollWidth: number +} + +export type ScrollSyncChildProps = { + clientHeight: number, + clientWidth: number, + onScroll: (params: OnScrollParams) => void, + scrollHeight: number, + scrollLeft: number, + scrollTop: number, + scrollWidth: number +} + +export type ScrollSyncProps = { + children?: (props: ScrollSyncChildProps) => React.ReactNode +}; + +export type ScrollSyncState = { + clientHeight: number, + clientWidth: number, + scrollHeight: number, + scrollLeft: number, + scrollTop: number, + scrollWidth: number +}; + +/** + * HOC that simplifies the process of synchronizing scrolling between two or more virtualized components. + */ +export class ScrollSync extends PureComponent { + static propTypes: { + /** + * Function responsible for rendering 2 or more virtualized components. + * This function should implement the following signature: + * ({ onScroll, scrollLeft, scrollTop }) => PropTypes.element + */ + children: Validator<(props: ScrollSyncChildProps) => React.ReactNode> + }; + + constructor(props: ScrollSyncProps, context: any); + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/Table.d.ts b/types/react-virtualized/dist/es/Table.d.ts new file mode 100644 index 0000000000..118215f4fa --- /dev/null +++ b/types/react-virtualized/dist/es/Table.d.ts @@ -0,0 +1,447 @@ +import { Validator, Requireable, PureComponent, Component } from 'react'; +import { CellMeasurerCache } from './CellMeasurer'; +import { Index, Alignment, ScrollEventData, IndexRange, OverscanIndexRange } from '../../index'; +import { Grid } from './Grid'; + +export type TableCellDataGetterParams = { + columnData?: any, + dataKey: string, + rowData: any +}; +export type TableCellProps = { + cellData?: any, + columnData?: any, + dataKey: string, + rowData: any, + rowIndex: number +}; +export type TableHeaderProps = { + columnData?: any, + dataKey: string, + disableSort?: boolean, + label?: string, + sortBy?: string, + sortDirection?: SortDirectionType +}; +export type TableHeaderRowProps = { + className: string, + columns: React.ReactNode[], + style: React.CSSProperties, + scrollbarWidth: number, + height: number, + width: number +}; +export type TableRowProps = { + className: string, + columns: any[], + index: number, + isScrolling: boolean, + onRowClick?: (params: RowMouseEventHandlerParams) => void, + onRowDoubleClick?: (params: RowMouseEventHandlerParams) => void, + onRowMouseOver?: (params: RowMouseEventHandlerParams) => void, + onRowMouseOut?: (params: RowMouseEventHandlerParams) => void, + rowData: any, + style: any +}; + +export type TableCellDataGetter = (params: TableCellDataGetterParams) => any; +export type TableCellRenderer = (props: TableCellProps) => React.ReactNode; +export type TableHeaderRenderer = (props: TableHeaderProps) => React.ReactNode; +export type TableHeaderRowRenderer = (props: TableHeaderRowProps) => React.ReactNode; +export type TableRowRenderer = (props: TableRowProps) => React.ReactNode; + +// https://github.com/bvaughn/react-virtualized/blob/master/docs/Column.md +export type ColumnProps = { + cellDataGetter?: TableCellDataGetter; + cellRenderer?: TableCellRenderer; + className?: string; + columnData?: any; + dataKey: any; + disableSort?: boolean; + flexGrow?: number; + flexShrink?: number; + headerClassName?: string; + headerRenderer?: TableHeaderRenderer; + label?: string; + maxWidth?: number; + minWidth?: number; + style?: React.CSSProperties; + width: number; +} +export class Column extends Component { + static propTypes: { + /** Optional aria-label value to set on the column header */ + 'aria-label': Requireable, + + /** + * Callback responsible for returning a cell's data, given its :dataKey + * ({ columnData: any, dataKey: string, rowData: any }): any + */ + cellDataGetter: Requireable, + + /** + * Callback responsible for rendering a cell's contents. + * ({ cellData: any, columnData: any, dataKey: string, rowData: any, rowIndex: number }): node + */ + cellRenderer: Requireable, + + /** Optional CSS class to apply to cell */ + className: Requireable, + + /** Optional additional data passed to this column's :cellDataGetter */ + columnData: Requireable, + + /** Uniquely identifies the row-data attribute correspnding to this cell */ + dataKey: Validator, + + /** If sort is enabled for the table at large, disable it for this column */ + disableSort: Requireable, + + /** Flex grow style; defaults to 0 */ + flexGrow: Requireable, + + /** Flex shrink style; defaults to 1 */ + flexShrink: Requireable, + + /** Optional CSS class to apply to this column's header */ + headerClassName: Requireable, + + /** + * Optional callback responsible for rendering a column header contents. + * ({ columnData: object, dataKey: string, disableSort: boolean, label: string, sortBy: string, sortDirection: string }): PropTypes.node + */ + headerRenderer: Validator, + + /** Header label for this column */ + label: Requireable, + + /** Maximum width of column; this property will only be used if :flexGrow is > 0. */ + maxWidth: Requireable, + + /** Minimum width of column. */ + minWidth: Requireable, + + /** Optional inline style to apply to cell */ + style: Requireable, + + /** Flex basis (width) for this column; This value can grow or shrink based on :flexGrow and :flexShrink properties. */ + width: Validator + }; + + static defaultProps: { + cellDataGetter: TableCellDataGetter, + cellRenderer: TableCellRenderer, + flexGrow: 0, + flexShrink: 1, + headerRenderer: TableHeaderRenderer, + style: {} + }; +} + +export type RowMouseEventHandlerParams = { + rowData: { + columnData: object, + id: string, + index: number + }, + index: number, + event: React.SyntheticEvent> +} + +export type HeaderMouseEventHandlerParams = { + dataKey: string, + columnData: any, + event: React.SyntheticEvent> +} + +// ref: https://github.com/bvaughn/react-virtualized/blob/master/docs/Table.md +export type TableProps = { + deferredMeasurementCache?: CellMeasurerCache; + autoHeight?: boolean; + children?: React.ReactChildren; + className?: string; + disableHeader?: boolean; + estimatedRowSize?: number; + gridClassName?: string; + gridStyle?: any; + headerClassName?: string; + headerHeight: number; + headerStyle?: any; + height?: number; + id?: string; + noRowsRenderer?: () => void; + onHeaderClick?: (params: HeaderMouseEventHandlerParams) => void; + onRowClick?: (info: RowMouseEventHandlerParams) => void; + onRowDoubleClick?: (info: RowMouseEventHandlerParams) => void; + onRowMouseOut?: (info: RowMouseEventHandlerParams) => void; + onRowMouseOver?: (info: RowMouseEventHandlerParams) => void; + onRowsRendered?: (info: IndexRange & OverscanIndexRange) => void; + overscanRowCount?: number; + onScroll?: (info: ScrollEventData) => void; + rowClassName?: string | ((info: Index) => string); + rowCount: number; + rowGetter?: (info: Index) => any; + rowHeight: number | ((info: Index) => number); + rowRenderer?: TableRowRenderer; + headerRowRenderer?: TableHeaderRowRenderer; + rowStyle?: React.CSSProperties | ((info: Index) => React.CSSProperties); + scrollToAlignment?: string; + scrollToIndex?: number; + scrollTop?: number; + sort?: (info: { sortBy: string, sortDirection: SortDirectionType }) => void; + sortBy?: string; + sortDirection?: SortDirectionType; + style?: React.CSSProperties; + tabIndex?: number; + width?: number; +} + +export const defaultTableCellDataGetter: TableCellDataGetter; +export const defaultTableCellRenderer: TableCellRenderer; +export const defaultTableHeaderRenderer: () => Array>; +export const defaultTableHeaderRowRenderer: TableHeaderRowRenderer; +export const defaultTableRowRenderer: TableRowRenderer; + +type SortDirectionStatic = { + /** + * Sort items in ascending order. + * This means arranging from the lowest value to the highest (e.g. a-z, 0-9). + */ + ASC: 'ASC', + + /** + * Sort items in descending order. + * This means arranging from the highest value to the lowest (e.g. z-a, 9-0). + */ + DESC: 'DESC' +} + +export const SortDirection: SortDirectionStatic + +export type SortDirectionType = 'ASC' | 'DESC' + +export const SortIndicator: React.StatelessComponent<{ sortDirection: SortDirectionType }> + +/** + * Table component with fixed headers and virtualized rows for improved performance with large data sets. + * This component expects explicit width, height, and padding parameters. + */ +export class Table extends PureComponent { + static propTypes: { + 'aria-label': Requireable, + + /** + * Removes fixed height from the scrollingContainer so that the total height + * of rows can stretch the window. Intended for use with WindowScroller + */ + autoHeight: Requireable, + + /** One or more Columns describing the data displayed in this row */ + children: Validator, + + /** Optional CSS class name */ + className: Requireable, + + /** Disable rendering the header at all */ + disableHeader: Requireable, + + /** + * Used to estimate the total height of a Table before all of its rows have actually been measured. + * The estimated total height is adjusted as rows are rendered. + */ + estimatedRowSize: Validator, + + /** Optional custom CSS class name to attach to inner Grid element. */ + gridClassName: Requireable, + + /** Optional inline style to attach to inner Grid element. */ + gridStyle: Requireable, + + /** Optional CSS class to apply to all column headers */ + headerClassName: Requireable, + + /** Fixed height of header row */ + headerHeight: Validator, + + /** + * Responsible for rendering a table row given an array of columns: + * Should implement the following interface: ({ + * className: string, + * columns: any[], + * style: any + * }): PropTypes.node + */ + headerRowRenderer: Requireable, + + /** Optional custom inline style to attach to table header columns. */ + headerStyle: Requireable, + + /** Fixed/available height for out DOM element */ + height: Validator, + + /** Optional id */ + id: Requireable, + + /** Optional renderer to be used in place of table body rows when rowCount is 0 */ + noRowsRenderer: Requireable<() => JSX.Element>, + + /** + * Optional callback when a column's header is clicked. + * ({ columnData: any, dataKey: string }): void + */ + onHeaderClick: Requireable<(params: HeaderMouseEventHandlerParams) => void>, + + /** + * Callback invoked when a user clicks on a table row. + * ({ index: number }): void + */ + onRowClick: Requireable<(params: RowMouseEventHandlerParams) => void>, + + /** + * Callback invoked when a user double-clicks on a table row. + * ({ index: number }): void + */ + onRowDoubleClick: Requireable<(params: RowMouseEventHandlerParams) => void>, + + /** + * Callback invoked when the mouse leaves a table row. + * ({ index: number }): void + */ + onRowMouseOut: Requireable<(params: RowMouseEventHandlerParams) => void>, + + /** + * Callback invoked when a user moves the mouse over a table row. + * ({ index: number }): void + */ + onRowMouseOver: Requireable<(params: RowMouseEventHandlerParams) => void>, + + /** + * Callback invoked with information about the slice of rows that were just rendered. + * ({ startIndex, stopIndex }): void + */ + onRowsRendered: Requireable<(params: RowMouseEventHandlerParams) => void>, + + /** + * Callback invoked whenever the scroll offset changes within the inner scrollable region. + * This callback can be used to sync scrolling between lists, tables, or grids. + * ({ clientHeight, scrollHeight, scrollTop }): void + */ + onScroll: Requireable<(params: ScrollEventData) => void>, + + /** + * Number of rows to render above/below the visible bounds of the list. + * These rows can help for smoother scrolling on touch devices. + */ + overscanRowCount: Validator, + + /** + * Optional CSS class to apply to all table rows (including the header row). + * This property can be a CSS class name (string) or a function that returns a class name. + * If a function is provided its signature should be: ({ index: number }): string + */ + rowClassName: Requireable string)>, + + /** + * Callback responsible for returning a data row given an index. + * ({ index: number }): any + */ + rowGetter: Validator<(params: Index) => any>, + + /** + * Either a fixed row height (number) or a function that returns the height of a row given its index. + * ({ index: number }): number + */ + rowHeight: Validator number)>, + + /** Number of rows in table. */ + rowCount: Validator, + + /** + * Responsible for rendering a table row given an array of columns: + * Should implement the following interface: ({ + * className: string, + * columns: Array, + * index: number, + * isScrolling: boolean, + * onRowClick: ?Function, + * onRowDoubleClick: ?Function, + * onRowMouseOver: ?Function, + * onRowMouseOut: ?Function, + * rowData: any, + * style: any + * }): PropTypes.node + */ + rowRenderer: Requireable<(props: TableRowProps) => React.ReactNode>, + + /** Optional custom inline style to attach to table rows. */ + rowStyle: Validator React.CSSProperties)>, + + /** See Grid#scrollToAlignment */ + scrollToAlignment: Validator, + + /** Row index to ensure visible (by forcefully scrolling if necessary) */ + scrollToIndex: Validator, + + /** Vertical offset. */ + scrollTop: Requireable, + + /** + * Sort function to be called if a sortable header is clicked. + * ({ sortBy: string, sortDirection: SortDirection }): void + */ + sort: Requireable<(params: { sortBy: string, sortDirection: SortDirectionType }) => void>, + + /** Table data is currently sorted by this :dataKey (if it is sorted at all) */ + sortBy: Requireable, + + /** Table data is currently sorted in this direction (if it is sorted at all) */ + sortDirection: Validator, + + /** Optional inline style */ + style: Requireable, + + /** Tab index for focus */ + tabIndex: Requireable, + + /** Width of list */ + width: Validator + }; + + static defaultProps: { + disableHeader: false, + estimatedRowSize: 30, + headerHeight: 0, + headerStyle: {}, + noRowsRenderer: () => null, + onRowsRendered: () => null, + onScroll: () => null, + overscanRowCount: 10, + rowRenderer: TableRowRenderer, + headerRowRenderer: TableHeaderRenderer, + rowStyle: {}, + scrollToAlignment: 'auto', + scrollToIndex: -1, + style: {} + }; + + Grid: Grid; + + constructor(props: TableProps); + + forceUpdateGrid(): void; + + /** See Grid#measureAllCells */ + measureAllRows(): void; + + /** See Grid#recomputeGridSize */ + recomputeRowHeights(index?: number): void; + + /** See Grid#scrollToCell */ + scrollToRow(index?: number): void + + componentDidMount(): void; + + componentDidUpdate(): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/dist/es/WindowScroller.d.ts b/types/react-virtualized/dist/es/WindowScroller.d.ts new file mode 100644 index 0000000000..7e0a09379e --- /dev/null +++ b/types/react-virtualized/dist/es/WindowScroller.d.ts @@ -0,0 +1,59 @@ +import { Validator, Requireable, PureComponent } from 'react' + +export type WindowScrollerChildProps = { + height: number, + isScrolling: boolean, + scrollTop: number +}; + +export type WindowScrollerProps = { + children?: (props: WindowScrollerChildProps) => React.ReactNode; + onResize?: (prams: { height: number }) => void; + onScroll?: (params: { scrollTop: number }) => void; + scrollElement?: HTMLElement; +} +export type WindowScrollerState = { + height: number, + isScrolling: boolean, + scrollTop: number +} + +export class WindowScroller extends PureComponent { + static propTypes: { + /** + * Function responsible for rendering children. + * This function should implement the following signature: + * ({ height, isScrolling, scrollTop }) => PropTypes.element + */ + children: Validator<(props: WindowScrollerChildProps) => React.ReactNode>, + + /** Callback to be invoked on-resize: ({ height }) */ + onResize: Validator<(params: { height: number }) => void>, + + /** Callback to be invoked on-scroll: ({ scrollTop }) */ + onScroll: Validator<(params: { scrollTop: number }) => void>, + + /** Element to attach scroll event listeners. Defaults to window. */ + scrollElement: HTMLElement + }; + + static defaultProps: { + onResize: () => {}, + onScroll: () => {} + }; + + constructor(props: WindowScrollerProps); + + // Can’t use defaultProps for scrollElement without breaking server-side rendering + readonly scrollElement: HTMLElement | Window; + + updatePosition(scrollElement?: HTMLElement): void; + + componentDidMount(): void; + + componentWillReceiveProps(nextProps: WindowScrollerProps): void; + + componentWillUnmount(): void; + + render(): JSX.Element; +} diff --git a/types/react-virtualized/index.d.ts b/types/react-virtualized/index.d.ts index f89183c90f..2440e1dcf3 100644 --- a/types/react-virtualized/index.d.ts +++ b/types/react-virtualized/index.d.ts @@ -1,545 +1,167 @@ -// Type definitions for react-virtualized 9.2.1 +// Type definitions for react-virtualized 9.4 // Project: https://github.com/bvaughn/react-virtualized // Definitions by: Kalle Ott // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.2 -import * as React from "react"; +export { + ArrowKeyStepper, + ArrowKeyStepperProps, + ChildProps as ArrowKeyStepperChildProps +} from './dist/es/ArrowKeyStepper' +export { + AutoSizer, + AutoSizerProps, + Dimensions +} from './dist/es/AutoSizer' +export { + CellMeasurer, + CellMeasurerCache, + CellMeasurerCacheParams, + CellMeasurerProps, + KeyMapper +} from './dist/es/CellMeasurer' +export { + Collection, + CollectionCellGroupRenderer, + CollectionCellGroupRendererParams, + CollectionCellRenderer, + CollectionCellRendererParams, + CollectionCellSizeAndPosition, + CollectionCellSizeAndPositionGetter, + CollectionProps +} from './dist/es/Collection' +export { + ColumnSizer, + ColumnSizerProps, + SizedColumnProps +} from './dist/es/ColumnSizer' +export { + defaultCellRangeRenderer, + Grid, + CellSizeAndPositionManager, + ConfigureParams, + ContainerSizeAndOffset, + GetVisibleCellRangeParams, + GridCellProps, + GridCellRangeProps, + GridCellRangeRenderer, + GridCellRenderer, + GridProps, + GridState, + OverscanIndices, + OverscanIndicesGetterParams, + ScrollDirection, + ScrollParams, + SectionRenderedParams, + SizeAndPositionData, + VisibleCellRange +} from './dist/es/Grid' +export { + InfiniteLoader, + InfiniteLoaderChildProps, + InfiniteLoaderProps +} from './dist/es/InfiniteLoader' +export { + List, + ListProps, + ListRowProps, + ListRowRenderer +} from './dist/es/List' +export { + createCellPositioner as createMasonryCellPositioner, + Masonry, + CellRenderer, + MasonryCellProps, + MasonryProps, + MasonryState, + OnCellsRenderedCallback, + OnScrollCallback, + Position, + Positioner +} from './dist/es/Masonry' +export { + MultiGrid, + MultiGridProps, + MultiGridState +} from './dist/es/MultiGrid' +export { + ScrollSync, + OnScrollParams, + ScrollSyncChildProps, + ScrollSyncProps, + ScrollSyncState +} from './dist/es/ScrollSync' +export { + defaultTableCellDataGetter, + defaultTableCellRenderer, + defaultTableHeaderRenderer, + defaultTableHeaderRowRenderer, + defaultTableRowRenderer, + Table, + Column, + SortDirection, + SortIndicator, + ColumnProps, + HeaderMouseEventHandlerParams, + RowMouseEventHandlerParams, + SortDirectionType, + TableCellDataGetter, + TableCellDataGetterParams, + TableCellProps, + TableCellRenderer, + TableHeaderProps, + TableHeaderRenderer, + TableHeaderRowProps, + TableHeaderRowRenderer, + TableProps, + TableRowProps, + TableRowRenderer +} from './dist/es/Table' +export { + WindowScroller, + WindowScrollerChildProps, + WindowScrollerProps, + WindowScrollerState +} from './dist/es/WindowScroller' -export interface ArrowKeyStepperProps { - children?: React.StatelessComponent<{ - onSectionRendered: Function, - scrollToColumn: number, - scrollToRow: number - }>; - className?: string; - columnCount: number; - rowCount: number; -} -export class ArrowKeyStepper extends React.PureComponent { } - -export interface AutoSizerProps { - disableHeight?: boolean; - disableWidth?: boolean; - onResize?: (info: { height: number, width: number }) => any; -} -export class AutoSizer extends React.PureComponent { } - -export interface CellMeasurerProps { - cache?: CellMeasurerCache; - children?: React.StatelessComponent<{ - getColumnWidth: () => number, - getRowHeight: () => number, - resetMeasurements: () => any, - resetMeasurementsForColumn: (index: number) => any, - resetMeasurementsForRow: (index: number) => any, - }>; - columnIndex: number; - parent?: React.ReactType; - rowIndex: number; - style?: React.CSSProperties; -} -export class CellMeasurer extends React.PureComponent { } - -export type KeyMapper = ( - rowIndex: number, - columnIndex: number -) => any; -export type Map = { [key: string]: T }; -export type Cache = Map; -export type IndexParam = { +export type Index = { index: number }; -export type CellMeasurerCacheParams = { - defaultHeight?: number, - defaultWidth?: number, - fixedHeight?: boolean, - fixedWidth?: boolean, - minHeight?: number, - minWidth?: number, - keyMapper?: KeyMapper -} -export class CellMeasurerCache { - constructor(params: CellMeasurerCacheParams); - clear( - rowIndex: number, - columnIndex: number - ): void; - clearAll(): void; - columnWidth: (params: IndexParam) => number | undefined; - hasFixedHeight(): boolean; - hasFixedWidth(): boolean; - getHeight( - rowIndex: number, - columnIndex: number - ): number | undefined; - getWidth( - rowIndex: number, - columnIndex: number - ): number | undefined; - has( - rowIndex: number, - columnIndex: number - ): boolean; - rowHeight: (params: IndexParam) => number | undefined; - set( - rowIndex: number, - columnIndex: number, - width: number, - height: number - ): void; -} - -export type CollectionCellSizeAndPosition = { height: number, width: number, x: number, y: number }; -export type CollectionCellSizeAndPositionGetter = (params: IndexParam) => CollectionCellSizeAndPosition; - -export type CollectionCellGroupRendererParams = { - cellSizeAndPositionGetter: CollectionCellSizeAndPositionGetter, - indices: number[], - cellRenderer: CollectionCellRenderer -} -export type CollectionCellGroupRenderer = (params: CollectionCellGroupRendererParams) => React.ReactNode[]; -export type CollectionCellRendererParams = { - index: number, - key: string, - style?: React.CSSProperties -} -export type CollectionCellRenderer = (params: CollectionCellRendererParams) => React.ReactNode; -export type CollectionProps = { - 'aria-label'?: string; - cellCount: number; - cellGroupRenderer?: CollectionCellGroupRenderer, - cellRenderer: CollectionCellRenderer, - cellSizeAndPositionGetter: CollectionCellSizeAndPositionGetter, - sectionSize?: number; +export type PositionInfo = { + x: number, + y: number }; -export class Collection extends React.PureComponent { } -export interface ColumnSizerProps { - children?: React.StatelessComponent<{ adjustedWidth: number, getColumnWidth: () => number, registerChild: any }>; - columnMaxWidth?: number; - columnMinWidth?: number; - columnCount?: number; - width: number; -} -export class ColumnSizer extends React.PureComponent { } +export type ScrollPosition = { + scrollLeft: number, + scrollTop: number +}; -export type CellDataGetterParams = { - columnData?: any, - dataKey: string, - rowData: any -}; -export type CellRendererParams = { - cellData?: any, - columnData?: any, - dataKey: string, - rowData: any, - rowIndex: number -}; -export type HeaderRendererParams = { - columnData?: any, - dataKey: string, - disableSort?: boolean, - label?: string, - sortBy?: string, - sortDirection?: SortDirectionType -}; -export type HeaderRowRendererParams = { - className: string, - columns: React.ReactNode[], - style: React.CSSProperties, - scrollbarWidth: number, +export type SizeInfo = { height: number, width: number }; -export type RowRendererParams = { - className: string, - columns: Array, - index: number, - isScrolling: boolean, - onRowClick?: Function, - onRowDoubleClick?: Function, - onRowMouseOver?: Function, - onRowMouseOut?: Function, - rowData: any, - style: any -}; -export type TableCellDataGetter = (params: CellDataGetterParams) => any; -export type TableCellRenderer = (params: CellRendererParams) => React.ReactNode; -export type TableHeaderRenderer = (params: HeaderRendererParams) => React.ReactNode; -export type TableHeaderRowRenderer = (params: HeaderRowRendererParams) => React.ReactNode; -export type TableRowRenderer = (params: RowRendererParams) => React.ReactNode; +export type SizeAndPositionInfo = SizeInfo & PositionInfo; -// https://github.com/bvaughn/react-virtualized/blob/master/docs/Column.md -export interface ColumnProps { - cellDataGetter?: TableCellDataGetter; - cellRenderer?: TableCellRenderer; - className?: string; - columnData?: any; - dataKey: any; - disableSort?: boolean; - flexGrow?: number; - flexShrink?: number; - headerClassName?: string; - headerRenderer?: TableHeaderRenderer; - label?: string; - maxWidth?: number; - minWidth?: number; - style?: React.CSSProperties; - width: number; -} -export class Column extends React.Component { } +export type Map = { [key: string]: T }; -export type RowClickHandlerParams = { - rowData: { - columnData: Object, - id: string, - index: number - } +export type Alignment = 'auto' | 'end' | 'start' | 'center'; + +export type IndexRange = { + startIndex: number, + stopIndex: number } -// ref: https://github.com/bvaughn/react-virtualized/blob/master/docs/Table.md -export interface TableProps { - deferredMeasurementCache?: CellMeasurerCache; - autoHeight?: boolean; - children?: React.ReactChildren; - className?: string; - disableHeader?: boolean; - estimatedRowSize?: number; - gridClassName?: string; - gridStyle?: any; - headerClassName?: string; - headerHeight: number; - headerStyle?: any; - height?: number; - id?: string; - noRowsRender?: () => void; - onHeaderClick?: (dataKey: string, columnData: any) => void; - onRowClick?: (info: RowClickHandlerParams) => void; - onRowDoubleClick?: (info: RowClickHandlerParams) => void; - onRowMouseOut?: (info: RowClickHandlerParams) => void; - onRowMouseOver?: (info: RowClickHandlerParams) => void; - onRowsRendered?: (info: RowClickHandlerParams) => void; - overscanRowCount?: number; - onScroll?: (info: { clientHeight: number, scrollHeight: number, scrollTop: number }) => void; - rowClassName?: string | ((info: IndexParam) => string); - rowCount: number; - rowGetter?: (info: IndexParam) => any; - rowHeight: number | ((info: IndexParam) => number); - rowRenderer?: TableRowRenderer; - headerRowRenderer?: TableHeaderRowRenderer; - rowStyle?: React.CSSProperties | ((info: IndexParam) => React.CSSProperties); - scrollToAlignment?: string; - scrollToIndex?: number; - scrollTop?: number; - sort?: (info: { sortBy: string, sortDirection: SortDirectionType }) => void; - sortBy?: string; - sortDirection?: SortDirectionType; - style?: React.CSSProperties; - tabIndex?: number; - width?: number; -} -export class Table extends React.PureComponent { - forceUpdateGrid(): void; - /** See Grid#measureAllCells */ - measureAllRows(): void; - /** See Grid#recomputeGridSize */ - recomputeRowHeights(index?: number): void; - /** See Grid#scrollToCell */ - scrollToRow(index?: number): void; - Grid: Grid; +export type OverscanIndexRange = { + overscanStartIndex: number, + overscanStopIndex: number, } -export const defaultTableCellDataGetter: TableCellDataGetter; -export const defaultTableCellRenderer: TableCellRenderer; -export const defaultTableHeaderRenderer: () => React.ReactElement[]; -export const defaultTableHeaderRowRenderer: TableHeaderRowRenderer; -export const defaultTableRowRenderer: TableRowRenderer; - -interface ISortDirection { - /** - * Sort items in ascending order. - * This means arranging from the lowest value to the highest (e.g. a-z, 0-9). - */ - ASC: 'ASC', - - /** - * Sort items in descending order. - * This means arranging from the highest value to the lowest (e.g. z-a, 9-0). - */ - DESC: 'DESC' -} - -export const SortDirection: ISortDirection - -export type SortDirectionType = 'ASC' | 'DESC' - -export const SortIndicator: React.StatelessComponent<{ sortDirection: SortDirectionType }> - - -export type DefaultCellRangeRendererParams = { - cellCache: Object, - cellRenderer: Function, - columnSizeAndPositionManager: Object, - columnStartIndex: number, - columnStopIndex: number, - horizontalOffsetAdjustment: number, - isScrolling: boolean, - rowSizeAndPositionManager: Object, - rowStartIndex: number, - rowStopIndex: number, - scrollLeft: number, - scrollTop: number, - styleCache: Object, - verticalOffsetAdjustment: number, - visibleColumnIndices: Object, - visibleRowIndices: Object -}; -export function defaultCellRangeRenderer(params: DefaultCellRangeRendererParams): React.ReactElement; - - -export type GridCellRendererParams = { - columnIndex: number; - isScrolling: boolean; - isVisible: boolean; - key: string; - parent: Grid | List | Table; - rowIndex: number; - style: React.CSSProperties; -}; -export type GridCellRenderer = (params: GridCellRendererParams) => React.ReactNode; - -export type ConfigureParams = { - cellCount: number, - estimatedCellSize: number -}; -export type ContainerSizeAndOffset = { - containerSize: number, - offset: number -}; -export type SizeAndPositionData = { - offset: number, - size: number -}; -export type GetVisibleCellRangeParams = { - containerSize: number, - offset: number -}; -export type VisibleCellRange = { - start: number; - stop: number; -} - -export type CellSizeAndPositionManager = { - areOffsetsAdjusted(): boolean; - configure({ - cellCount, - estimatedCellSize - }: ConfigureParams): void; - getCellCount(): number; - getEstimatedCellSize(): number; - getLastMeasuredIndex(): number; - getOffsetAdjustment({ - containerSize, - offset // safe - }: ContainerSizeAndOffset): number; - /** - * This method returns the size and position for the cell at the specified index. - * It just-in-time calculates (or used cached values) for cells leading up to the index. - */ - getSizeAndPositionOfCell(index: number): SizeAndPositionData; - getSizeAndPositionOfLastMeasuredCell(): SizeAndPositionData; - /** - * Total size of all cells being measured. - * This value will be completedly estimated initially. - * As cells as measured the estimate will be updated. - */ - getTotalSize(): number; - /** - * Determines a new offset that ensures a certain cell is visible, given the current offset. - * If the cell is already visible then the current offset will be returned. - * If the current offset is too great or small, it will be adjusted just enough to ensure the specified index is visible. - * - * @param align Desired alignment within container; one of "auto" (default), "start", or "end" - * @param containerSize Size (width or height) of the container viewport - * @param currentOffset Container's current (x or y) offset - * @param totalSize Total size (width or height) of all cells - * @return Offset to use to ensure the specified cell is visible - */ - getUpdatedOffsetForIndex(params: { - align: string, - containerSize: number, - currentOffset: number, - targetIndex: number - }): number; - getVisibleCellRange(params: GetVisibleCellRangeParams): VisibleCellRange; - /** - * Clear all cached values for cells after the specified index. - * This method should be called for any cell that has changed its size. - * It will not immediately perform any calculations; they'll be performed the next time getSizeAndPositionOfCell() is called. - */ - resetCell(index: number): void -} - -export type GridCellRangeRendererParams = { - cellCache: Map, - cellRenderer: GridCellRenderer, - columnSizeAndPositionManager: CellSizeAndPositionManager, - columnStartIndex: number, - columnStopIndex: number, - isScrolling: boolean, - rowSizeAndPositionManager: CellSizeAndPositionManager, - rowStartIndex: number, - rowStopIndex: number, - scrollLeft: number, +export type ScrollEventData = { + clientHeight: number, + scrollHeight: number, scrollTop: number } -export type GridCellRangeRenderer = (params: GridCellRangeRendererParams) => React.ReactNode[]; -// TODO add proper typing -export type GridProps = { - 'aria-label'?: string; - autoContainerWidth?: boolean; - autoHeight?: boolean; - cellRenderer: GridCellRenderer; - cellRangeRenderer?: GridCellRangeRenderer; - className?: string; - columnCount: number; - columnWidth: number | ((params: IndexParam) => number); - containerStyle?: React.CSSProperties; - deferredMeasurementCache?: CellMeasurerCache; - estimatedColumnSize?: number; - estimatedRowSize?: number; - getScrollbarSize?: () => number; - height: number; - id?: string; - noContentRenderer?: () => React.ReactNode; - onScroll?: (params: { clientHeight: number, clientWidth: number, scrollHeight: number, scrollLeft: number, scrollTop: number, scrollWidth: number }) => any; - onSectionRendered?: (params: { columnStartIndex: number, columnStopIndex: number, rowStartIndex: number, rowStopIndex: number }) => any; - overscanColumnCount?: number; - overscanIndicesGetter?: (params: { - cellCount: number, - overscanCellsCount: number, - scrollDirection: number, - startIndex: number, - stopIndex: number - }) => { overscanStartIndex: number, overscanStopIndex: number }; - overscanRowCount?: number; - rowHeight: number | ((params: IndexParam) => number); - rowCount: number; - scrollingResetTimeInterval?: number; - scrollLeft?: number; - scrollToAlignment?: 'auto' | 'end' | 'start' | 'center'; - scrollToColumn?: number; - scrollTop?: number; - scrollToRow?: number; - style?: React.CSSProperties; - tabIndex?: number; - width: number; -}; -export class Grid extends React.PureComponent { - /** - * Invalidate Grid size and recompute visible cells. - * This is a deferred wrapper for recomputeGridSize(). - * It sets a flag to be evaluated on cDM/cDU to avoid unnecessary renders. - * This method is intended for advanced use-cases like CellMeasurer. - */ - invalidateCellSizeAfterRender(params: { - columnIndex: number, - rowIndex: number - }): void; - /** - * Pre-measure all columns and rows in a Grid. - * Typically cells are only measured as needed and estimated sizes are used for cells that have not yet been measured. - * This method ensures that the next call to getTotalSize() returns an exact size (as opposed to just an estimated one). - */ - measureAllCells(): void; - /** - * Forced recompute of row heights and column widths. - * This function should be called if dynamic column or row sizes have changed but nothing else has. - * Since Grid only receives :columnCount and :rowCount it has no way of detecting when the underlying data changes. - */ - recomputeGridSize(params?: { - columnIndex?: number, - rowIndex?: number - }): void; - /** - * Ensure column and row are visible. - */ - scrollToCell(params: { - columnIndex: number, - rowIndex: number - }): void; -} - -export type InfiniteLoaderProps = { - children?: React.StatelessComponent<{ - onRowsRendered: (params: { startIndex: number, stopIndex: number }) => void, - registerChild: (registeredChild: any) => void - }>; - isRowLoaded: (params: IndexParam) => boolean; - loadMoreRows: (params: { startIndex: number, stopIndex: number }) => Promise; - minimumBatchSize?: number; - rowCount?: number; - threshold?: number; -}; -export class InfiniteLoader extends React.PureComponent { } -export type ListRowRenderer = (params: GridCellRendererParams & { index: number, style: React.CSSProperties }) => React.ReactNode; -export interface ListProps { - className?: string; - autoHeight?: boolean; - estimatedRowSize?: number; - height: number; - noRowsRenderer?: Function; - onRowsRendered?: (info: { overscanStartIndex: number, overscanStopIndex: number, startIndex: number, stopIndex: number }) => void; - onScroll?: (info: { clientHeight: number, scrollHeight: number, scrollTop: number }) => void; - overscanRowCount?: number; - rowHeight: number | ((info: IndexParam) => number); - rowRenderer: ListRowRenderer; - rowCount: number; - scrollToAlignment?: string; - scrollToIndex?: number; - scrollTop?: number; - style?: React.CSSProperties; - tabIndex?: number; - width: number; -} -export class List extends React.PureComponent { } - -export interface MultiGridProps { - fixedColumnCount: number; - fixedRowCount: number; - style: React.CSSProperties; - styleBottomLeftGrid: React.CSSProperties; - styleBottomRightGrid: React.CSSProperties; - styleTopLeftGrid: React.CSSProperties; - styleTopRightGrid: React.CSSProperties; -} -export class MultiGrid extends React.PureComponent { } - -export type ScrollSyncProps = { - children?: React.StatelessComponent<{ - clientHeight: number, - clientWidth: number, - onScroll: (params: { clientHeight: number, clientWidth: number, scrollHeight: number, scrollLeft: number, scrollTop: number, scrollWidth: number }) => void, - scrollHeight: number, - scrollLeft: number, - scrollTop: number, - scrollWidth: number - }>; -}; -export class ScrollSync extends React.PureComponent { } -export type WindowScrollerRenderCallBackParams = { - height: number, - isScrolling: boolean, - scrollTop: number -}; - -export type WindowScrollerProps = { - children?: React.StatelessComponent; - onResize?: (prams: { height: number }) => void; - onScroll?: (params: { scrollTop: number }) => void; - scrollElement?: HTMLElement; -} -export class WindowScroller extends React.PureComponent { } diff --git a/types/react-virtualized/react-virtualized-tests.tsx b/types/react-virtualized/react-virtualized-tests.tsx index aa1dc087a9..18de45e25a 100644 --- a/types/react-virtualized/react-virtualized-tests.tsx +++ b/types/react-virtualized/react-virtualized-tests.tsx @@ -1,156 +1,106 @@ -import * as React from "react"; -import * as ReactDOM from "react-dom"; +import * as React from 'react'; +import { PureComponent } from 'react' +import { ArrowKeyStepper, AutoSizer, Grid } from 'react-virtualized' -import { - Collection, - SortDirection, - Grid, - ArrowKeyStepper, - AutoSizer, - CellMeasurer, - ColumnSizer, - InfiniteLoader, - ScrollSync, - WindowScroller, - WindowScrollerRenderCallBackParams, - List, - Column, - Table, -} from "react-virtualized"; +export class ArrowKeyStepperExample extends PureComponent { + constructor(props) { + super(props) -/* - * Collection - */ + this._getColumnWidth = this._getColumnWidth.bind(this) + this._getRowHeight = this._getRowHeight.bind(this) + this._cellRenderer = this._cellRenderer.bind(this) + } -function CollectionTest() { - const list = [ - { name: "Brian Vaughn", x: 13, y: 34, width: 123, size: 234, height: 123 } - ]; + render() { + const { mode } = this.state - // Render your grid - ReactDOM.render( - list[index].name} - cellSizeAndPositionGetter={({ index }) => { - const datum = list[index]; - return { - height: datum.height, - width: datum.width, - x: datum.x, - y: datum.y - }; - }} - />, - document.getElementById("example") - ); + return ( + + + {({ onSectionRendered, scrollToColumn, scrollToRow }) => ( +
    + + + {({ width }) => ( + this._cellRenderer({ columnIndex, key, rowIndex, scrollToColumn, scrollToRow, style })} + rowHeight={this._getRowHeight} + rowCount={100} + scrollToColumn={scrollToColumn} + scrollToRow={scrollToRow} + width={width} + /> + )} + +
    + )} +     + ) + } + + _getColumnWidth({ index }) { + return (1 + (index % 3)) * 60 + } + + _getRowHeight({ index }) { + return (1 + (index % 3)) * 30 + } + + _cellRenderer({ columnIndex, key, rowIndex, scrollToColumn, scrollToRow, style }) { + + return ( +
    + {`r:${rowIndex}, c:${columnIndex}`} +
    + ) + } } -function GridTest() { - // Grid data as an array of arrays - const list = [ - ['Brian Vaughn', 'Software Engineer', 'San Jose', 'CA', 95125 /* ... */] - // And so on... - ]; +import { List } from 'react-virtualized' - // Render your grid - ReactDOM.render( - list[rowIndex][columnIndex]} - />, - document.getElementById('example') - ); -} +export class AutoSizerExample extends PureComponent { + constructor(props) { + super(props) -function ListTest() { - // List data - const list = [ - { name: 'Brian Vaughn', occupation: 'Software Engineer', location: 'San Jose, CA, 95125' /* ... */ } - // And so on... - ]; + this._rowRenderer = this._rowRenderer.bind(this) + } - // Render your List - ReactDOM.render( - list[index]} - />, - document.getElementById('example') - ); -} + render() { + const { list } = this.context + const { hideDescription } = this.state -function TableTest() { - const list = [ - { name: 'Brian Vaughn', description: 'Software engineer' } - // And so on... - ]; - ReactDOM.render( - list[index]} - > - - -
    , - document.getElementById('example') - ); -} + return ( + + {({ width, height }) => ( + + )} + + ) + } -function ArrowKeyStepperTest() { - const columnCount = 12; - const rowCount = 3; - - ReactDOM.render( - - {({ onSectionRendered, scrollToColumn, scrollToRow }) => ( - null} - columnCount={columnCount} - onSectionRendered={onSectionRendered} - rowCount={rowCount} - scrollToColumn={scrollToColumn} - scrollToRow={scrollToRow} - /> - )} - , - document.getElementById('example') - ); -} - -function AutoSizerTest() { - // List data as an array of strings - const list = [ - 'Brian Vaughn' - // And so on... - ]; - const _rowRenderer = ({ index, key, style }) => { - - const row = list[index]; + _rowRenderer({ index, key, style }) { + const { list } = this.context + const row = list.get(index) return (
    - {row} + {row.name} +
    + ) + } +} +import { } from 'react' +import { CellMeasurer, CellMeasurerCache } from 'react-virtualized' + +export class DynamicHeightList extends PureComponent { + + _cache: CellMeasurerCache + + constructor(props, context) { + super(props, context) + + this._cache = new CellMeasurerCache({ + fixedWidth: true, + minHeight: 50 + }) + + this._rowRenderer = this._rowRenderer.bind(this) + } + + render() { + const { width } = this.props + + return ( + + ) + } + + _rowRenderer({ index, isScrolling, key, parent, style }) { + const { getClassName, list } = this.props + + const datum = list.get(index % list.size) + const classNames = getClassName({ columnIndex: 0, rowIndex: index }) + + const imageWidth = 300 + const imageHeight = datum.size * 2 + + const source = `http://fillmurray.com/${imageWidth}/${imageHeight}` + + return ( + + {({ measure }) => ( +
    + +
    + )} +     + ) + } +} + +import { Collection } from 'react-virtualized' + +// Defines a pattern of sizes and positions for a range of 10 rotating cells +// These cells cover an area of 600 (wide) x 400 (tall) +const GUTTER_SIZE = 3 +const CELL_WIDTH = 75 + +export class CollectionExample extends PureComponent { + _columnYMap: any; + + constructor(props, context) { + super(props, context) + + this.context = context; + + this.state = { + cellCount: context.list.size, + columnCount: this._getColumnCount(context.list.size), + height: 300, + horizontalOverscanSize: 0, + scrollToCell: undefined, + showScrollingPlaceholder: false, + verticalOverscanSize: 0 + } + + this._columnYMap = [] + + this._cellRenderer = this._cellRenderer.bind(this) + this._cellSizeAndPositionGetter = this._cellSizeAndPositionGetter.bind(this) + this._noContentRenderer = this._noContentRenderer.bind(this) + this._onCellCountChange = this._onCellCountChange.bind(this) + this._onHeightChange = this._onHeightChange.bind(this) + this._onHorizontalOverscanSizeChange = this._onHorizontalOverscanSizeChange.bind(this) + this._onScrollToCellChange = this._onScrollToCellChange.bind(this) + this._onVerticalOverscanSizeChange = this._onVerticalOverscanSizeChange.bind(this) + } + + render() { + const { cellCount, height, horizontalOverscanSize, scrollToCell, showScrollingPlaceholder, verticalOverscanSize } = this.state + + return ( + + {({ width }) => ( + + )} + + ) + } + + _cellRenderer({ index, isScrolling, key, style }) { + const { list } = this.context + const { showScrollingPlaceholder } = this.state + + const datum = list.get(index % list.size) + + // Customize style + style.backgroundColor = datum.color + + return ( +
    + {showScrollingPlaceholder && isScrolling ? '...' : index}
    ) } - // Render your list - ReactDOM.render( - - {({ width, height }) => ( - { - const row = list[index]; + _cellSizeAndPositionGetter({ index }) { + const { list } = this.context + const { columnCount } = this.state - return ( -
    - {row} -
    - ) - }} - width={width} - /> - )} -     , - document.getElementById('example') - ); -} + const columnPosition = index % (columnCount || 1) + const datum = list.get(index % list.size) -function CellMeasurerTest() { - const columnCount = 12; - const rowCount = 3; - const cellRenderer = ({ columnIndex, rowIndex }) => `${rowIndex}, ${columnIndex}`; - const fixedRowHeight = 42; - const height = 12; - const width = 12; + // Poor man's Masonry layout; columns won't all line up equally with the bottom. + const height = datum.size + const width = CELL_WIDTH + const x = columnPosition * (GUTTER_SIZE + width) + const y = this._columnYMap[columnPosition] || 0 - ReactDOM.render( - - {({ getColumnWidth }) => ( - - )} - , - document.getElementById('example') - ); -} + this._columnYMap[columnPosition] = y + height + GUTTER_SIZE -function ColumnSizerTest() { - ReactDOM.render( - - {({ adjustedWidth, getColumnWidth, registerChild }) => ( - "test"} - rowHeight={50} - rowCount={12} - width={adjustedWidth} - /> - )} - , - document.getElementById('example') - ); -} - -function InfiniteLoaderTest() { - const list: string[] = []; - - function isRowLoaded({ index }) { - return !!list[index]; + return { + height, + width, + x, + y + } } - function loadMoreRows({ startIndex, stopIndex }: { startIndex: number, stopIndex: number }) { - return new Promise(resolve => resolve(list.push('test'))); + _getColumnCount(cellCount) { + return Math.round(Math.sqrt(cellCount)) } - function rowRenderer({ index, key, style }) { - const content = list[index]; + _onHorizontalOverscanSizeChange(event) { + const horizontalOverscanSize = parseInt(event.target.value, 10) || 0 + + this.setState({ horizontalOverscanSize }) + } + + _noContentRenderer() { + return ( +
    + No cells +
    + ) + } + + _onCellCountChange(event) { + const cellCount = parseInt(event.target.value, 10) || 0 + + this._columnYMap = [] + + this.setState({ + cellCount, + columnCount: this._getColumnCount(cellCount) + }) + } + + _onHeightChange(event) { + const height = parseInt(event.target.value, 10) || 0 + + this.setState({ height }) + } + + _onScrollToCellChange(event) { + const { cellCount } = this.state + + let scrollToCell = Math.min(cellCount - 1, parseInt(event.target.value, 10)) + + if (isNaN(scrollToCell)) { + scrollToCell = undefined + } + + this.setState({ scrollToCell }) + } + + _onVerticalOverscanSizeChange(event) { + const verticalOverscanSize = parseInt(event.target.value, 10) || 0 + + this.setState({ verticalOverscanSize }) + } +} + +import { ColumnSizer } from 'react-virtualized' + +export class ColumnSizerExample extends PureComponent { + constructor(props) { + super(props) + + this._noColumnMaxWidthChange = this._noColumnMaxWidthChange.bind(this) + this._noColumnMinWidthChange = this._noColumnMinWidthChange.bind(this) + this._onColumnCountChange = this._onColumnCountChange.bind(this) + this._noContentRenderer = this._noContentRenderer.bind(this) + this._cellRenderer = this._cellRenderer.bind(this) + } + + render() { + const { + columnMaxWidth, + columnMinWidth, + columnCount + } = this.state + + return ( +
    + + {({ width }) => ( + + {({ adjustedWidth, getColumnWidth, registerChild }) => ( +
    + +
    + )} +     + )} +     +
    + ) + } + + _noColumnMaxWidthChange(event) { + let columnMaxWidth = parseInt(event.target.value, 10) + + if (isNaN(columnMaxWidth)) { + columnMaxWidth = undefined + } else { + columnMaxWidth = Math.min(1000, columnMaxWidth) + } + + this.setState({ columnMaxWidth }) + } + + _noColumnMinWidthChange(event) { + let columnMinWidth = parseInt(event.target.value, 10) + + if (isNaN(columnMinWidth)) { + columnMinWidth = undefined + } else { + columnMinWidth = Math.max(1, columnMinWidth) + } + + this.setState({ columnMinWidth }) + } + + _onColumnCountChange(event) { + this.setState({ columnCount: parseInt(event.target.value, 10) || 0 }) + } + + _noContentRenderer() { + return ( +
    + No cells +
    + ) + } + + _cellRenderer({ columnIndex, key, rowIndex, style }) { + const className = columnIndex === 0 + ? 'styles.firstCell' + : 'styles.cell' + + return ( +
    + {`R:${rowIndex}, C:${columnIndex}`} +
    + ) + } +} + +export class GridExample extends PureComponent { + constructor(props, context) { + super(props, context) + + this.state = { + columnCount: 1000, + height: 300, + overscanColumnCount: 0, + overscanRowCount: 10, + rowHeight: 40, + rowCount: 1000, + scrollToColumn: undefined, + scrollToRow: undefined, + useDynamicRowHeight: false + } + + this._cellRenderer = this._cellRenderer.bind(this) + this._getColumnWidth = this._getColumnWidth.bind(this) + this._getRowClassName = this._getRowClassName.bind(this) + this._getRowHeight = this._getRowHeight.bind(this) + this._noContentRenderer = this._noContentRenderer.bind(this) + this._onColumnCountChange = this._onColumnCountChange.bind(this) + this._onRowCountChange = this._onRowCountChange.bind(this) + this._onScrollToColumnChange = this._onScrollToColumnChange.bind(this) + this._onScrollToRowChange = this._onScrollToRowChange.bind(this) + this._renderBodyCell = this._renderBodyCell.bind(this) + this._renderLeftSideCell = this._renderLeftSideCell.bind(this) + } + + render() { + const { + columnCount, + height, + overscanColumnCount, + overscanRowCount, + rowHeight, + rowCount, + scrollToColumn, + scrollToRow, + useDynamicRowHeight + } = this.state + + return ( + + + {({ width }) => ( + + )} + + ) + } + + _cellRenderer({ columnIndex, key, rowIndex, style }) { + if (columnIndex === 0) { + return this._renderLeftSideCell({ key, rowIndex, style }) + } else { + return this._renderBodyCell({ columnIndex, key, rowIndex, style }) + } + } + + _getColumnWidth({ index }) { + switch (index) { + case 0: + return 50 + case 1: + return 100 + case 2: + return 300 + default: + return 80 + } + } + + _getDatum(index) { + const { list } = this.context + + return list.get(index % list.size) + } + + _getRowClassName(row) { + return row % 2 === 0 ? 'styles.evenRow' : 'styles.oddRow' + } + + _getRowHeight({ index }) { + return this._getDatum(index).size + } + + _noContentRenderer() { + return ( +
    + No cells +
    + ) + } + + _renderBodyCell({ columnIndex, key, rowIndex, style }) { + const rowClass = this._getRowClassName(rowIndex) + const datum = this._getDatum(rowIndex) + + let content + + switch (columnIndex) { + case 1: + content = datum.name + break + case 2: + content = datum.random + break + default: + content = `r:${rowIndex}, c:${columnIndex}` + break + } + + return ( +
    + {content} +
    + ) + } + + _renderLeftSideCell({ key, rowIndex, style }) { + const datum = this._getDatum(rowIndex) + + // Don't modify styles. + // These are frozen by React now (as of 16.0.0). + // Since Grid caches and re-uses them, they aren't safe to modify. + style = { + ...style, + backgroundColor: datum.color + } + + return ( +
    + {datum.name.charAt(0)} +
    + ) + } + + _updateUseDynamicRowHeights(value) { + this.setState({ + useDynamicRowHeight: value + }) + } + + _onColumnCountChange(event) { + const columnCount = parseInt(event.target.value, 10) || 0 + + this.setState({ columnCount }) + } + + _onRowCountChange(event) { + const rowCount = parseInt(event.target.value, 10) || 0 + + this.setState({ rowCount }) + } + + _onScrollToColumnChange(event) { + const { columnCount } = this.state + let scrollToColumn = Math.min(columnCount - 1, parseInt(event.target.value, 10)) + + if (isNaN(scrollToColumn)) { + scrollToColumn = undefined + } + + this.setState({ scrollToColumn }) + } + + _onScrollToRowChange(event) { + const { rowCount } = this.state + let scrollToRow = Math.min(rowCount - 1, parseInt(event.target.value, 10)) + + if (isNaN(scrollToRow)) { + scrollToRow = undefined + } + + this.setState({ scrollToRow }) + } +} + +import { InfiniteLoader } from 'react-virtualized' + +const STATUS_LOADING = 1 +const STATUS_LOADED = 2 + +export class InfiniteLoaderExample extends PureComponent { + _timeoutIdMap: any; + + constructor(props) { + super(props) + + this._timeoutIdMap = {} + + this._clearData = this._clearData.bind(this) + this._isRowLoaded = this._isRowLoaded.bind(this) + this._loadMoreRows = this._loadMoreRows.bind(this) + this._rowRenderer = this._rowRenderer.bind(this) + } + + componentWillUnmount() { + Object.keys(this._timeoutIdMap).forEach(timeoutId => { + clearTimeout(timeoutId as any) + }) + } + + render() { + const { list } = this.context + const { loadedRowCount, loadingRowCount } = this.state + + return ( + + {({ onRowsRendered, registerChild }) => ( + + {({ width }) => ( + + )} + + )} + + ) + } + + _clearData() { + this.setState({ + loadedRowCount: 0, + loadedRowsMap: {}, + loadingRowCount: 0 + }) + } + + _isRowLoaded({ index }) { + const { loadedRowsMap } = this.state + return !!loadedRowsMap[index] // STATUS_LOADING or STATUS_LOADED + } + + _loadMoreRows({ startIndex, stopIndex }) { + const { loadedRowsMap, loadingRowCount } = this.state + const increment = stopIndex - startIndex + 1 + + for (let i = startIndex; i <= stopIndex; i++) { + loadedRowsMap[i] = STATUS_LOADING + } + + this.setState({ + loadingRowCount: loadingRowCount + increment + }) + + const timeoutId = setTimeout(() => { + const { loadedRowCount, loadingRowCount } = this.state + + delete this._timeoutIdMap[timeoutId] + + for (let i = startIndex; i <= stopIndex; i++) { + loadedRowsMap[i] = STATUS_LOADED + } + + this.setState({ + loadingRowCount: loadingRowCount - increment, + loadedRowCount: loadedRowCount + increment + }) + + promiseResolver() + }, 1000 + Math.round(Math.random() * 2000)) + + this._timeoutIdMap[timeoutId] = true + + let promiseResolver + + return new Promise(resolve => { + promiseResolver = resolve + }) + } + + _rowRenderer({ index, key, style }) { + const { list } = this.context + const { loadedRowsMap } = this.state + + const row = list.get(index) + let content + + if (loadedRowsMap[index] === STATUS_LOADED) { + content = row.name + } else { + content = ( +
    + ) + } return (
    ) } - - - // Render your list - ReactDOM.render( - - {({ onRowsRendered, registerChild }) => ( - - {({ width }) => ( - - )} - - )} - , - document.getElementById('example') - ); } -function ScrollSyncTest() { - function hexToRgb(hex) { - const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex) - return result ? { - r: parseInt(result[1], 16), - g: parseInt(result[2], 16), - b: parseInt(result[3], 16) - } : null +export class ListExample extends PureComponent { + + constructor(props, context) { + super(props, context) + + this.state = { + listHeight: 300, + listRowHeight: 50, + overscanRowCount: 10, + rowCount: context.list.size, + scrollToIndex: undefined, + showScrollingPlaceholder: false, + useDynamicRowHeight: false + } + + this._getRowHeight = this._getRowHeight.bind(this) + this._noRowsRenderer = this._noRowsRenderer.bind(this) + this._onRowCountChange = this._onRowCountChange.bind(this) + this._onScrollToRowChange = this._onScrollToRowChange.bind(this) + this._rowRenderer = this._rowRenderer.bind(this) } - const LEFT_COLOR_FROM = hexToRgb('#471061') - const LEFT_COLOR_TO = hexToRgb('#BC3959') - const TOP_COLOR_FROM = hexToRgb('#000000') - const TOP_COLOR_TO = hexToRgb('#333333') - const columnWidth = 20; - const rowHeight = 10; - const overscanColumnCount = 10; - const overscanRowCount = 10; - const height = 10; - const rowCount = 100; - const columnCount = 100; + render() { + const { + listHeight, + listRowHeight, + overscanRowCount, + rowCount, + scrollToIndex, + showScrollingPlaceholder, + useDynamicRowHeight + } = this.state + return ( + + {({ width }) => ( + + )} + + ) + } - function mixColors(color1, color2, amount) { - const weight1 = amount - const weight2 = 1 - amount + _getDatum(index) { + const { list } = this.context - const r = Math.round(weight1 * color1.r + weight2 * color2.r) - const g = Math.round(weight1 * color1.g + weight2 * color2.g) - const b = Math.round(weight1 * color1.b + weight2 * color2.b) + return list.get(index % list.size) + } - return { r, g, b } - }; + _getRowHeight({ index }) { + return this._getDatum(index).size + } - function renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) { + _noRowsRenderer() { + return ( +
    + No rows +
    + ) + } + + _onRowCountChange(event) { + const rowCount = parseInt(event.target.value, 10) || 0 + + this.setState({ rowCount }) + } + + _onScrollToRowChange(event) { + const { rowCount } = this.state + let scrollToIndex = Math.min(rowCount - 1, parseInt(event.target.value, 10)) + + if (isNaN(scrollToIndex)) { + scrollToIndex = undefined + } + + this.setState({ scrollToIndex }) + } + + _rowRenderer({ index, isScrolling, key, style }) { + const { + showScrollingPlaceholder, + useDynamicRowHeight + } = this.state + + if ( + showScrollingPlaceholder && + isScrolling + ) { + return ( +
    + Scrolling... +
    + ) + } + + const datum = this._getDatum(index) + + let additionalContent + + if (useDynamicRowHeight) { + switch (datum.size) { + case 75: + additionalContent =
    It is medium-sized.
    + break + case 100: + additionalContent =
    It is large-sized.
    It has a 3rd row.
    + break + } + } + + return ( +
    +
    + {datum.name.charAt(0)} +
    +
    +
    + {datum.name} +
    +
    + This is row {index} +
    + {additionalContent} +
    + {useDynamicRowHeight && + + {datum.size}px + + } +
    + ) + } +} + +import { + WindowScroller, + createMasonryCellPositioner as createCellPositioner, + Positioner, + Masonry, + MasonryCellProps +} from 'react-virtualized' + +export class GridExample2 extends PureComponent { + _columnCount: number; + _cache: CellMeasurerCache; + _columnHeights: any; + _width: number; + _height: number; + _scrollTop: number; + _cellPositioner?: Positioner; + _masonry: Masonry; + + constructor(props, context) { + super(props, context) + + this._columnCount = 0 + + this._cache = new CellMeasurerCache({ + defaultHeight: 250, + defaultWidth: 200, + fixedWidth: true + }) + + this._columnHeights = {} + + this.state = { + columnWidth: 200, + height: 300, + gutterSize: 10, + windowScrollerEnabled: false + } + + this._cellRenderer = this._cellRenderer.bind(this) + this._onResize = this._onResize.bind(this) + this._renderAutoSizer = this._renderAutoSizer.bind(this) + this._renderMasonry = this._renderMasonry.bind(this) + this._setMasonryRef = this._setMasonryRef.bind(this) + } + + render() { + const { + columnWidth, + height, + gutterSize, + windowScrollerEnabled + } = this.state + + let child + + if (windowScrollerEnabled) { + child = ( + + {this._renderAutoSizer} + + ) + } else { + child = this._renderAutoSizer({ height }) + } + + return ( +
    + {child} +
    + ) + } + + _calculateColumnCount() { + const { + columnWidth, + gutterSize + } = this.state + + this._columnCount = Math.floor(this._width / (columnWidth + gutterSize)) + } + + _cellRenderer({ index, key, parent, style }: MasonryCellProps) { + const { list } = this.context + const { columnWidth } = this.state + + const datum = list.get(index % list.size) + + return ( + +
    +
    + {datum.random} +
    + + ) + } + + _initCellPositioner() { + if (typeof this._cellPositioner === 'undefined') { + const { + columnWidth, + gutterSize + } = this.state + + this._cellPositioner = createCellPositioner({ + cellMeasurerCache: this._cache, + columnCount: this._columnCount, + columnWidth, + spacer: gutterSize + }) + } + } + + _onResize({ height, width }) { + this._width = width + + this._columnHeights = {} + this._calculateColumnCount() + this._resetCellPositioner() + this._masonry.recomputeCellPositions() + } + + _renderAutoSizer({ height, scrollTop }: { height: number, scrollTop?: number }) { + this._height = height + this._scrollTop = scrollTop + + return ( + + {this._renderMasonry} + + ) + } + + _renderMasonry({ width }) { + this._width = width + + this._calculateColumnCount() + this._initCellPositioner() + + const { height, windowScrollerEnabled } = this.state + + return ( + + ) + } + + _resetCellPositioner() { + const { + columnWidth, + gutterSize + } = this.state + + this._cellPositioner.reset({ + columnCount: this._columnCount, + columnWidth, + spacer: gutterSize + }) + } + + _setMasonryRef(ref) { + this._masonry = ref + } +} + +import { MultiGrid } from 'react-virtualized' + +const STYLE: React.CSSProperties = { + border: '1px solid #ddd', + overflow: 'hidden' +} +const STYLE_BOTTOM_LEFT_GRID: React.CSSProperties = { + borderRight: '2px solid #aaa', + backgroundColor: '#f7f7f7' +} +const STYLE_TOP_LEFT_GRID: React.CSSProperties = { + borderBottom: '2px solid #aaa', + borderRight: '2px solid #aaa', + fontWeight: 'bold' +} +const STYLE_TOP_RIGHT_GRID: React.CSSProperties = { + borderBottom: '2px solid #aaa', + fontWeight: 'bold' +} + +export class MultiGridExample extends PureComponent { + state + _onFixedColumnCountChange + _onFixedRowCountChange + _onScrollToColumnChange + _onScrollToRowChange + + constructor(props, context) { + super(props, context) + + this.state = { + fixedColumnCount: 2, + fixedRowCount: 1, + scrollToColumn: 0, + scrollToRow: 0 + } + + this._cellRenderer = this._cellRenderer.bind(this) + this._onFixedColumnCountChange = this._createEventHandler('fixedColumnCount') + this._onFixedRowCountChange = this._createEventHandler('fixedRowCount') + this._onScrollToColumnChange = this._createEventHandler('scrollToColumn') + this._onScrollToRowChange = this._createEventHandler('scrollToRow') + } + + render() { + return ( + + {({ width }) => ( + + )} + + ) + } + + _cellRenderer({ columnIndex, key, rowIndex, style }) { + return ( +
    + {columnIndex}, {rowIndex} +
    + ) + } + + _createEventHandler(property) { + return (event) => { + const value = parseInt(event.target.value, 10) || 0 + + this.setState({ + [property]: value + }) + } + } + + _createLabeledInput(property, eventHandler) { + const value = this.state[property] + + return ( + `` + ) + } +} + +import { ScrollSync } from 'react-virtualized' + +const LEFT_COLOR_FROM = hexToRgb('#471061') +const LEFT_COLOR_TO = hexToRgb('#BC3959') +const TOP_COLOR_FROM = hexToRgb('#000000') +const TOP_COLOR_TO = hexToRgb('#333333') + +function scrollbarSize() { return 42; } +export class GridExample3 extends PureComponent { + state + constructor(props, context) { + super(props, context) + + this.state = { + columnWidth: 75, + columnCount: 50, + height: 300, + overscanColumnCount: 0, + overscanRowCount: 5, + rowHeight: 40, + rowCount: 100 + } + + this._renderBodyCell = this._renderBodyCell.bind(this) + this._renderHeaderCell = this._renderHeaderCell.bind(this) + this._renderLeftSideCell = this._renderLeftSideCell.bind(this) + } + + render() { + const { + columnCount, + columnWidth, + height, + overscanColumnCount, + overscanRowCount, + rowHeight, + rowCount + } = this.state + + return ( + + + {({ clientHeight, clientWidth, onScroll, scrollHeight, scrollLeft, scrollTop, scrollWidth }) => { + const x = scrollLeft / (scrollWidth - clientWidth) + const y = scrollTop / (scrollHeight - clientHeight) + + const leftBackgroundColor = mixColors(LEFT_COLOR_FROM, LEFT_COLOR_TO, y) + const leftColor = '#ffffff' + const topBackgroundColor = mixColors(TOP_COLOR_FROM, TOP_COLOR_TO, x) + const topColor = '#ffffff' + const middleBackgroundColor = mixColors(leftBackgroundColor, topBackgroundColor, 0.5) + const middleColor = '#ffffff' + + return ( +
    +
    + +
    +
    + +
    +
    + + {({ width }) => ( +
    +
    + +
    +
    + +
    +
    + )} +     +
    +
    + ) + }} +     + ) + } + + _renderBodyCell({ columnIndex, key, rowIndex, style }) { + if (columnIndex < 1) { + return + } + + return this._renderLeftSideCell({ columnIndex, key, rowIndex, style }) + } + + _renderHeaderCell({ columnIndex, key, rowIndex, style }) { + if (columnIndex < 1) { + return + } + + return this._renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) + } + + _renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) { return (
    ) - }; - function renderLeftSideCell({ columnIndex, key, rowIndex, style }) { - const rowClass = rowIndex % 2 === 0 - ? columnIndex % 2 === 0 ? 'styles.evenRow' : 'styles.oddRow' - : columnIndex % 2 !== 0 ? 'styles.evenRow' : 'styles.oddRow' - const classNames = [rowClass, 'styles.cell'].join(' ') + } + _renderLeftSideCell({ columnIndex, key, rowIndex, style }) { return (
    {`R${rowIndex}, C${columnIndex}`}
    ) - }; + } +} - function renderHeaderCell({ columnIndex, key, rowIndex, style }) { - if (columnIndex < 1) { - return +function hexToRgb(hex) { + const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex) + return result ? { + r: parseInt(result[1], 16), + g: parseInt(result[2], 16), + b: parseInt(result[3], 16) + } : null +} + +/** + * Ported from sass implementation in C + * https://github.com/sass/libsass/blob/0e6b4a2850092356aa3ece07c6b249f0221caced/functions.cpp#L209 + */ +function mixColors(color1, color2, amount) { + const weight1 = amount + const weight2 = 1 - amount + + const r = Math.round(weight1 * color1.r + weight2 * color2.r) + const g = Math.round(weight1 * color1.g + weight2 * color2.g) + const b = Math.round(weight1 * color1.b + weight2 * color2.b) + + return { r, g, b } +} + +import { Column, Table, SortDirection, SortIndicator } from 'react-virtualized' + +export class TableExample extends PureComponent { + state; + context; + constructor(props, context) { + super(props, context) + + this.state = { + disableHeader: false, + headerHeight: 30, + height: 270, + hideIndexRow: false, + overscanRowCount: 10, + rowHeight: 40, + rowCount: 1000, + scrollToIndex: undefined, + sortBy: 'index', + sortDirection: SortDirection.ASC, + useDynamicRowHeight: false } - return renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) - }; - - function renderBodyCell({ columnIndex, key, rowIndex, style }) { - if (columnIndex < 1) { - return - } - - return renderLeftSideCell({ columnIndex, key, rowIndex, style }) + this._getRowHeight = this._getRowHeight.bind(this) + this._headerRenderer = this._headerRenderer.bind(this) + this._noRowsRenderer = this._noRowsRenderer.bind(this) + this._onRowCountChange = this._onRowCountChange.bind(this) + this._onScrollToRowChange = this._onScrollToRowChange.bind(this) + this._rowClassName = this._rowClassName.bind(this) + this._sort = this._sort.bind(this) } - return ( - - {({ clientHeight, clientWidth, onScroll, scrollHeight, scrollLeft, scrollTop, scrollWidth }) => { - const x = scrollLeft / (scrollWidth - clientWidth) - const y = scrollTop / (scrollHeight - clientHeight) + render() { + const { + disableHeader, + headerHeight, + height, + hideIndexRow, + overscanRowCount, + rowHeight, + rowCount, + scrollToIndex, + sortBy, + sortDirection, + useDynamicRowHeight + } = this.state - const leftBackgroundColor = mixColors(LEFT_COLOR_FROM, LEFT_COLOR_TO, y) - const leftColor = '#ffffff' - const topBackgroundColor = mixColors(TOP_COLOR_FROM, TOP_COLOR_TO, x) - const topColor = '#ffffff' - const middleBackgroundColor = mixColors(leftBackgroundColor, topBackgroundColor, 0.5) - const middleColor = '#ffffff' - - return ( -
    -
    - -
    -
    - -
    -
    - - {({ width }) => ( -
    -
    - -
    -
    - -
    -
    - )} -     -
    -
    + const { list } = this.context + const sortedList = this._isSortEnabled() + ? list + .sortBy(item => item[sortBy]) + .update(list => + sortDirection === SortDirection.DESC + ? list.reverse() + : list ) - }} -     - ); -} + : list -function WindowScrollerTest() { - const onScroll = function ({scrollTop}: { scrollTop: number }) { }; - const onResize = function ({height}: { height: number }) { }; - const list = [ - { name: 'Brian Vaughn', description: 'Software engineer' } - // And so on... - ]; - ReactDOM.render( - - {({ height, isScrolling, scrollTop }) => ( + const rowGetter = ({ index }) => this._getDatum(sortedList, index) + + return ( +
    {({ width }) => ( - list[index].name} - scrollTop={scrollTop} + noRowsRenderer={this._noRowsRenderer} + overscanRowCount={overscanRowCount} + rowClassName={this._rowClassName} + rowHeight={useDynamicRowHeight ? this._getRowHeight : rowHeight} + rowGetter={rowGetter} + rowCount={rowCount} + scrollToIndex={scrollToIndex} + sort={this._sort} + sortBy={sortBy} + sortDirection={sortDirection} width={width} - /> + > + {!hideIndexRow && + rowData.index + } + dataKey='index' + disableSort={!this._isSortEnabled()} + width={60} + /> + } + + cellData + } + flexGrow={1} + /> + )} - )} - , - document.getElementById('example') - ); - // test that onScroll & onResize are optional - ReactDOM.render( - , - document.getElementById('example') - ); +
    + ) + } + + _getDatum(list, index) { + return list.get(index % list.size) + } + + _getRowHeight({ index }) { + const { list } = this.context + + return this._getDatum(list, index).size + } + + _headerRenderer({ + columnData, + dataKey, + disableSort, + label, + sortBy, + sortDirection + }) { + return ( +
    + Full Name + {sortBy === dataKey && + + } +
    + ) + } + + _isSortEnabled() { + const { list } = this.context + const { rowCount } = this.state + + return rowCount <= list.size + } + + _noRowsRenderer() { + return ( +
    + No rows +
    + ) + } + + _onRowCountChange(event) { + const rowCount = parseInt(event.target.value, 10) || 0 + + this.setState({ rowCount }) + } + + _onScrollToRowChange(event) { + const { rowCount } = this.state + let scrollToIndex = Math.min(rowCount - 1, parseInt(event.target.value, 10)) + + if (isNaN(scrollToIndex)) { + scrollToIndex = undefined + } + + this.setState({ scrollToIndex }) + } + + _rowClassName({ index }) { + if (index < 0) { + return 'styles.headerRow' + } else { + return index % 2 === 0 ? 'styles.evenRow' : 'styles.oddRow' + } + } + + _sort({ sortBy, sortDirection }) { + this.setState({ sortBy, sortDirection }) + } + + _updateUseDynamicRowHeight(value) { + this.setState({ + useDynamicRowHeight: value + }) + } +} + +export class WindowScrollerExample extends PureComponent { + state; + context; + _windowScroller: WindowScroller; + + constructor(props) { + super(props) + + this.state = { + showHeaderText: true + } + + this._hideHeader = this._hideHeader.bind(this) + this._rowRenderer = this._rowRenderer.bind(this) + this._onCheckboxChange = this._onCheckboxChange.bind(this) + this._setRef = this._setRef.bind(this) + } + + render() { + const { list, isScrollingCustomElement, customElement } = this.context + const { showHeaderText } = this.state + + return ( + +
    + + {({ height, isScrolling, scrollTop }) => ( + + {({ width }) => ( + this._rowRenderer({ index, isScrolling, isVisible, key, style })} + scrollTop={scrollTop} + width={width} + /> + )} + + )} + +
    + ) + } + + _hideHeader() { + const { showHeaderText } = this.state + + this.setState({ + showHeaderText: !showHeaderText + }, () => { + this._windowScroller.updatePosition() + }) + } + + _rowRenderer({ index, isScrolling, isVisible, key, style }) { + const { list } = this.context + const row = list.get(index) + + return ( +
    + {row.name} +
    + ) + } + + _setRef(windowScroller) { + this._windowScroller = windowScroller + } + + _onCheckboxChange(event) { + this.context.setScrollingCustomElement(event.target.checked) + } } diff --git a/types/react-virtualized/tsconfig.json b/types/react-virtualized/tsconfig.json index ac62cf83d8..7e2936975f 100644 --- a/types/react-virtualized/tsconfig.json +++ b/types/react-virtualized/tsconfig.json @@ -19,6 +19,32 @@ }, "files": [ "index.d.ts", + "dist/es/ArrowKeyStepper.d.ts", + "dist/es/AutoSizer.d.ts", + "dist/es/CellMeasurer.d.ts", + "dist/es/Collection.d.ts", + "dist/es/ColumnSizer.d.ts", + "dist/es/Grid.d.ts", + "dist/es/InfiniteLoader.d.ts", + "dist/es/List.d.ts", + "dist/es/Masonry.d.ts", + "dist/es/MultiGrid.d.ts", + "dist/es/ScrollSync.d.ts", + "dist/es/Table.d.ts", + "dist/es/WindowScroller.d.ts", + "dist/commonjs/ArrowKeyStepper.d.ts", + "dist/commonjs/AutoSizer.d.ts", + "dist/commonjs/CellMeasurer.d.ts", + "dist/commonjs/Collection.d.ts", + "dist/commonjs/ColumnSizer.d.ts", + "dist/commonjs/Grid.d.ts", + "dist/commonjs/InfiniteLoader.d.ts", + "dist/commonjs/List.d.ts", + "dist/commonjs/Masonry.d.ts", + "dist/commonjs/MultiGrid.d.ts", + "dist/commonjs/ScrollSync.d.ts", + "dist/commonjs/Table.d.ts", + "dist/commonjs/WindowScroller.d.ts", "react-virtualized-tests.tsx" ] } \ No newline at end of file diff --git a/types/react-virtualized/tslint.json b/types/react-virtualized/tslint.json new file mode 100644 index 0000000000..65f4cad455 --- /dev/null +++ b/types/react-virtualized/tslint.json @@ -0,0 +1,12 @@ +{ + "extends": "../tslint.json", + "rules": { + "interface-over-type-literal": false, + "semicolon": [ + false + ], + "prefer-method-signature": false, + "prefer-declare-function": false, + "no-padding": false + } +} \ No newline at end of file diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 73cb0ae16f..3464d91746 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -2,7 +2,7 @@ // Project: http://facebook.github.io/react/ // Definitions by: Asana , AssureSign , Microsoft , John Reilly , Benoit Benezech , Patricio Zavolinsky , Digiguru // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.2 export = React; export as namespace React; @@ -1504,7 +1504,7 @@ declare namespace React { /** * The overflow property controls how extra content exceeding the bounding box of an element is rendered. It can be used in conjunction with an element that has a fixed width and height, to eliminate text-induced page distortion. */ - overflow?: CSSWideKeyword | any; + overflow?: CSSWideKeyword | "auto" | "hidden" | "scroll" | "visible"; /** * Specifies the preferred scrolling methods for elements that overflow. @@ -1514,12 +1514,12 @@ declare namespace React { /** * Controls how extra content exceeding the x-axis of the bounding box of an element is rendered. */ - overflowX?: CSSWideKeyword | any; + overflowX?: CSSWideKeyword | "auto" | "hidden" | "scroll" | "visible"; /** * Controls how extra content exceeding the y-axis of the bounding box of an element is rendered. */ - overflowY?: CSSWideKeyword | any; + overflowY?: CSSWideKeyword | "auto" | "hidden" | "scroll" | "visible"; /** * The padding optional CSS property sets the required padding space on one to four sides of an element. The padding area is the space between an element and its border. Negative values are not allowed but decimal values are permitted. The element size is treated as fixed, and the content of the element shifts toward the center as padding is increased. diff --git a/types/react/test/cssProperties.tsx b/types/react/test/cssProperties.tsx index 1221a0effc..a453589f23 100644 --- a/types/react/test/cssProperties.tsx +++ b/types/react/test/cssProperties.tsx @@ -27,6 +27,9 @@ const justifyContentStyleTest =
    ; const boxShadowStyle: React.CSSProperties = { boxShadow: '2px 2px 2px 1px rgba(0, 0, 0, 0.2)' }; const boxShadowStyleTest =
    ; +const overflowStyle: React.CSSProperties = { overflow: 'auto', overflowX: 'visible', overflowY: 'scroll' }; +const overflowStyleTest =
    ; + // SVG specific style attribute declarations const fillOpacityStyle: React.CSSProperties = { fillOpacity: 0.3 }; diff --git a/types/reactstrap/index.d.ts b/types/reactstrap/index.d.ts index 198b410ed4..6dadd6d284 100644 --- a/types/reactstrap/index.d.ts +++ b/types/reactstrap/index.d.ts @@ -4,79 +4,79 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -export { default as Alert } from './lib/Alert' -export { default as Badge } from './lib/Badge' -export { default as Breadcrumb } from './lib/Breadcrumb' -export { default as BreadcrumbItem } from './lib/BreadcrumbItem' -export { default as Button } from './lib/Button' -export { default as ButtonDropdown } from './lib/ButtonDropdown' -export { default as ButtonGroup } from './lib/ButtonGroup' -export { default as ButtonToolbar } from './lib/ButtonToolbar' -export { default as Card } from './lib/Card' -export { default as CardBlock } from './lib/CardBlock' -export { default as CardColumns } from './lib/CardColumns' -export { default as CardDeck } from './lib/CardDeck' -export { default as CardFooter } from './lib/CardFooter' -export { default as CardGroup } from './lib/CardGroup' -export { default as CardHeader } from './lib/CardHeader' -export { default as CardImg } from './lib/CardImg' -export { default as CardImgOverlay } from './lib/CardImgOverlay' -export { default as CardLink } from './lib/CardLink' -export { default as CardSubtitle } from './lib/CardSubtitle' -export { default as CardText } from './lib/CardText' -export { default as CardTitle } from './lib/CardTitle' -export { default as Col } from './lib/Col' -export { default as Collapse } from './lib/Collapse' -export { default as Container } from './lib/Container' -export { default as Dropdown } from './lib/Dropdown' -export { default as DropdownItem } from './lib/DropdownItem' -export { default as DropdownMenu } from './lib/DropdownMenu' -export { default as DropdownToggle } from './lib/DropdownToggle' -export { default as Fade } from './lib/Fade' -export { default as Form } from './lib/Form' -export { default as FormFeedback } from './lib/FormFeedback' -export { default as FormGroup } from './lib/FormGroup' -export { default as FormText } from './lib/FormText' -export { default as Input } from './lib/Input' -export { default as InputGroup } from './lib/InputGroup' -export { default as InputGroupAddon } from './lib/InputGroupAddon' -export { default as InputGroupButton } from './lib/InputGroupButton' -export { default as Jumbotron } from './lib/Jumbotron' -export { default as Label } from './lib/Label' -export { default as ListGroup } from './lib/ListGroup' -export { default as ListGroupItem } from './lib/ListGroupItem' -export { default as ListGroupItemHeading } from './lib/ListGroupItemHeading' -export { default as ListGroupItemText } from './lib/ListGroupItemText' -export { default as Media } from './lib/Media' -export { default as Modal } from './lib/Modal' -export { default as ModalBody } from './lib/ModalBody' -export { default as ModalFooter } from './lib/ModalFooter' -export { default as ModalHeader } from './lib/ModalHeader' -export { default as Nav } from './lib/Nav' -export { default as Navbar } from './lib/Navbar' -export { default as NavbarBrand } from './lib/NavbarBrand' -export { default as NavbarToggler } from './lib/NavbarToggler' -export { default as NavDropdown } from './lib/NavDropdown' -export { default as NavItem } from './lib/NavItem' -export { default as NavLink } from './lib/NavLink' -export { default as Pagination } from './lib/Pagination' -export { default as PaginationItem } from './lib/PaginationItem' -export { default as PaginationLink } from './lib/PaginationLink' -export { default as Popover } from './lib/Popover' -export { default as PopoverContent } from './lib/PopoverContent' -export { default as PopoverTitle } from './lib/PopoverTitle' -export { default as Progress } from './lib/Progress' -export { default as Row } from './lib/Row' -export { default as TabContent } from './lib/TabContent' -export { default as Table } from './lib/Table' -export { default as TabPane } from './lib/TabPane' -export { default as Tag } from './lib/Tag' -export { default as TetherContent } from './lib/TetherContent' -export { default as Tooltip } from './lib/Tooltip' +export { default as Alert } from './lib/Alert'; +export { default as Badge } from './lib/Badge'; +export { default as Breadcrumb } from './lib/Breadcrumb'; +export { default as BreadcrumbItem } from './lib/BreadcrumbItem'; +export { default as Button } from './lib/Button'; +export { default as ButtonDropdown } from './lib/ButtonDropdown'; +export { default as ButtonGroup } from './lib/ButtonGroup'; +export { default as ButtonToolbar } from './lib/ButtonToolbar'; +export { default as Card } from './lib/Card'; +export { default as CardBlock } from './lib/CardBlock'; +export { default as CardColumns } from './lib/CardColumns'; +export { default as CardDeck } from './lib/CardDeck'; +export { default as CardFooter } from './lib/CardFooter'; +export { default as CardGroup } from './lib/CardGroup'; +export { default as CardHeader } from './lib/CardHeader'; +export { default as CardImg } from './lib/CardImg'; +export { default as CardImgOverlay } from './lib/CardImgOverlay'; +export { default as CardLink } from './lib/CardLink'; +export { default as CardSubtitle } from './lib/CardSubtitle'; +export { default as CardText } from './lib/CardText'; +export { default as CardTitle } from './lib/CardTitle'; +export { default as Col } from './lib/Col'; +export { default as Collapse } from './lib/Collapse'; +export { default as Container } from './lib/Container'; +export { default as Dropdown } from './lib/Dropdown'; +export { default as DropdownItem } from './lib/DropdownItem'; +export { default as DropdownMenu } from './lib/DropdownMenu'; +export { default as DropdownToggle } from './lib/DropdownToggle'; +export { default as Fade } from './lib/Fade'; +export { default as Form } from './lib/Form'; +export { default as FormFeedback } from './lib/FormFeedback'; +export { default as FormGroup } from './lib/FormGroup'; +export { default as FormText } from './lib/FormText'; +export { default as Input } from './lib/Input'; +export { default as InputGroup } from './lib/InputGroup'; +export { default as InputGroupAddon } from './lib/InputGroupAddon'; +export { default as InputGroupButton } from './lib/InputGroupButton'; +export { default as Jumbotron } from './lib/Jumbotron'; +export { default as Label } from './lib/Label'; +export { default as ListGroup } from './lib/ListGroup'; +export { default as ListGroupItem } from './lib/ListGroupItem'; +export { default as ListGroupItemHeading } from './lib/ListGroupItemHeading'; +export { default as ListGroupItemText } from './lib/ListGroupItemText'; +export { default as Media } from './lib/Media'; +export { default as Modal } from './lib/Modal'; +export { default as ModalBody } from './lib/ModalBody'; +export { default as ModalFooter } from './lib/ModalFooter'; +export { default as ModalHeader } from './lib/ModalHeader'; +export { default as Nav } from './lib/Nav'; +export { default as Navbar } from './lib/Navbar'; +export { default as NavbarBrand } from './lib/NavbarBrand'; +export { default as NavbarToggler } from './lib/NavbarToggler'; +export { default as NavDropdown } from './lib/NavDropdown'; +export { default as NavItem } from './lib/NavItem'; +export { default as NavLink } from './lib/NavLink'; +export { default as Pagination } from './lib/Pagination'; +export { default as PaginationItem } from './lib/PaginationItem'; +export { default as PaginationLink } from './lib/PaginationLink'; +export { default as Popover } from './lib/Popover'; +export { default as PopoverContent } from './lib/PopoverContent'; +export { default as PopoverTitle } from './lib/PopoverTitle'; +export { default as Progress } from './lib/Progress'; +export { default as Row } from './lib/Row'; +export { default as TabContent } from './lib/TabContent'; +export { default as Table } from './lib/Table'; +export { default as TabPane } from './lib/TabPane'; +export { default as Tag } from './lib/Tag'; +export { default as TetherContent } from './lib/TetherContent'; +export { default as Tooltip } from './lib/Tooltip'; export { UncontrolledAlert, UncontrolledButtonDropdown, UncontrolledDropdown, UncontrolledNavDropdown, UncontrolledTooltip -} from './lib/Uncontrolled' \ No newline at end of file +} from './lib/Uncontrolled'; diff --git a/types/reactstrap/reactstrap-tests.tsx b/types/reactstrap/reactstrap-tests.tsx index 71ab35ff9b..d4320246b7 100644 --- a/types/reactstrap/reactstrap-tests.tsx +++ b/types/reactstrap/reactstrap-tests.tsx @@ -76,8 +76,7 @@ import { Tooltip } from 'reactstrap'; - -//--------------- Alert +// --------------- Alert const Examplea = (props: any) => { return (
    @@ -103,7 +102,7 @@ class AlertExample extends React.Component { this.state = { visible: true - } + }; } onDismiss = () => { @@ -127,7 +126,7 @@ function AlertExample1() { ); } -//--------------- Badge +// --------------- Badge class Example2 extends React.Component { render() { return ( @@ -173,7 +172,7 @@ class Example4 extends React.Component { } } -//------------- Breadcrumbs +// ------------- Breadcrumbs const Example5 = (props: any) => { return (
    @@ -206,7 +205,7 @@ const Example6 = (props: any) => { ); }; -//------------- Buttons +// ------------- Buttons class Example7 extends React.Component { render() { return ( @@ -243,35 +242,35 @@ const Example9 = ( {' '}
    -) +); const Example10 = (
    {' '}
    -) +); const Example11 = (
    -) +); const Example12 = (
    {' '}
    -) +); const Example13 = (
    {' '}
    -) +); class Example14 extends React.Component { constructor(props: any) { @@ -320,7 +319,7 @@ class Example14 extends React.Component { } } -//------------- Button Dropdown +// ------------- Button Dropdown class Example15 extends React.Component { constructor(props: any) { super(props); @@ -368,7 +367,7 @@ const Example16 = ( Another Action -) +); const Example17 = (props: any) => ( true}> @@ -382,7 +381,7 @@ const Example17 = (props: any) => ( Another Action -) +); const Example18 = (
    @@ -406,7 +405,7 @@ const Example18 = (
    -) +); const Example19 = ( true} dropup> @@ -418,11 +417,9 @@ const Example19 = ( Another Action -) +); - - -//--------------- ButtonGroup +// --------------- ButtonGroup class Example20 extends React.Component { render() { return ( @@ -478,7 +475,7 @@ const Example22 = (props: any) => (
    -) +); const Example23 = (props: any) => ( @@ -494,8 +491,7 @@ const Example23 = (props: any) => ( - -) +); const Example24 = (props: any) => ( @@ -511,10 +507,9 @@ const Example24 = (props: any) => ( -) +); - -//------------------ Cards +// ------------------ Cards const Example25 = (props: any) => { return (
    @@ -862,8 +857,7 @@ const Example36 = (props: any) => { ); }; - -//------------------ Collapse +// ------------------ Collapse class Example37 extends React.Component { constructor(props: any) { @@ -937,8 +931,7 @@ class Example38 extends React.Component { } } - -//------- Dropdown +// ------- Dropdown class Example39 extends React.Component { constructor(props: any) { @@ -987,11 +980,11 @@ const Example40 = (props: any) => ( Another Action -) +); const Example41 = (props: any) => ( Header -) +); const Example42 = (props: any) => (
    @@ -1014,7 +1007,7 @@ const Example42 = (props: any) => (
    -) +); class Example43 extends React.Component { constructor(props: any) { @@ -1071,8 +1064,7 @@ function Example44() { ); } - -//------------------ Form +// ------------------ Form class Example45 extends React.Component { render() { return ( @@ -1476,7 +1468,7 @@ const Example53 = (props: any) => {
    ); -} +}; const Example54 = (props: any) => { return ( @@ -1602,7 +1594,6 @@ const Example59 = (props: any) => { ); }; - const Example60 = (props: any) => { return (
    @@ -1933,8 +1924,7 @@ const Example71 = () => { ); }; - -//--------------- Modal +// --------------- Modal class ModalExample72 extends React.Component { constructor(props: any) { super(props); @@ -2322,7 +2312,7 @@ class Example80 extends React.Component { } } -//----------- Pagination +// ----------- Pagination class Example81 extends React.Component { render() { return ( @@ -2363,7 +2353,6 @@ class Example81 extends React.Component { } } - class Example82 extends React.Component { render() { return ( @@ -2404,7 +2393,6 @@ class Example82 extends React.Component { } } - class Example83 extends React.Component { render() { return ( @@ -2465,8 +2453,7 @@ class Example84 extends React.Component { } } - -//------------------------- Popover +// ------------------------- Popover class Example85 extends React.Component { constructor(props: any) { super(props); @@ -2529,7 +2516,7 @@ class PopoverItem extends React.Component { } } -class PopoverExampleMulti extends React.Component { +class PopoverExampleMulti extends React.Component}> { constructor(props: any) { super(props); @@ -2566,8 +2553,7 @@ class PopoverExampleMulti extends React.Component { return ( @@ -2711,8 +2697,7 @@ const Example92 = (props: any) => { ); }; - -//--------------- Table +// --------------- Table class Example93 extends React.Component { render() { return ( @@ -3103,7 +3088,6 @@ class Example101 extends React.Component { } } - class Example102 extends React.Component { constructor(props: any) { super(props); @@ -3132,7 +3116,6 @@ class Example102 extends React.Component { } } - class Example103 extends React.Component { constructor(props: any) { super(props); diff --git a/types/readline-sync/index.d.ts b/types/readline-sync/index.d.ts index 78d7e313f9..677dbaf75c 100644 --- a/types/readline-sync/index.d.ts +++ b/types/readline-sync/index.d.ts @@ -18,7 +18,7 @@ interface BasicOptions { keepWhitespace?: boolean; encoding?: string; bufferSize?: number; - print?: (display: string, encoding: string) => void; + print?(display: string, encoding: string): void; history?: boolean; cd?: boolean; charlist?: string; @@ -29,7 +29,7 @@ interface BasicOptions { exists?: any; isFile?: boolean; isDirectory?: boolean; - validate?: (path: string) => boolean | string; + validate?(path: string): boolean | string; create?: boolean; guide?: boolean; } @@ -84,4 +84,4 @@ export function setPrint(value: (display: string, encoding: string) => void): vo /** * @deprecated Use the prompt option instead: readlineSync.setDefaultOptions({prompt: value}); */ -export function setPrompt(value: any): void; \ No newline at end of file +export function setPrompt(value: any): void; diff --git a/types/realm/index.d.ts b/types/realm/index.d.ts index 5f48d75ff7..993f0bcc0f 100644 --- a/types/realm/index.d.ts +++ b/types/realm/index.d.ts @@ -6,15 +6,15 @@ declare namespace Realm { /** - * PropertyType - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~PropertyType } - */ + * PropertyType + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~PropertyType } + */ type PropertyType = string | 'bool' | 'int' | 'float' | 'double' | 'string' | 'data' | 'date' | 'list'; /** - * ObjectSchemaProperty - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectSchemaProperty } - */ + * ObjectSchemaProperty + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectSchemaProperty } + */ interface ObjectSchemaProperty { type: PropertyType; objectType?: string; @@ -29,9 +29,9 @@ declare namespace Realm { } /** - * ObjectSchema - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectSchema } - */ + * ObjectSchema + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectSchema } + */ interface ObjectSchema { name: string; primaryKey?: string; @@ -39,17 +39,17 @@ declare namespace Realm { } /** - * ObjectClass - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectClass } - */ + * ObjectClass + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectClass } + */ interface ObjectClass { schema: ObjectSchema; } /** - * ObjectType - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectType } - */ + * ObjectType + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~ObjectType } + */ interface ObjectType { type: ObjectClass; } @@ -60,9 +60,9 @@ declare namespace Realm { } /** - * realm configuration - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~Configuration } - */ + * realm configuration + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.html#~Configuration } + */ interface Configuration { encryptionKey?: any; migration?: any; @@ -79,9 +79,9 @@ declare namespace Realm { } /** - * SortDescriptor - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Collection.html#~SortDescriptor } - */ + * SortDescriptor + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Collection.html#~SortDescriptor } + */ type SortDescriptor = string | [string, boolean] | any[]; /** @@ -99,9 +99,9 @@ declare namespace Realm { } /** - * Collection - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Collection.html } - */ + * Collection + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Collection.html } + */ interface Collection { readonly length: number; @@ -237,9 +237,9 @@ declare namespace Realm { } /** - * Object - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Object.html } - */ + * Object + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Object.html } + */ interface Object { /** * @returns boolean @@ -248,9 +248,9 @@ declare namespace Realm { } /** - * List - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.List.html } - */ + * List + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.List.html } + */ interface List extends Collection { /** * @returns T @@ -284,9 +284,9 @@ declare namespace Realm { } /** - * Results - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Results.html } - */ + * Results + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Results.html } + */ type Results = Collection; /** @@ -341,15 +341,15 @@ declare namespace Realm { } /** - * LogLevel - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.html#~LogLevel } - */ + * LogLevel + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.html#~LogLevel } + */ type LogLevelType = string | 'error' | 'info' | 'defug'; /** - * Sync - * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.html } - */ + * Sync + * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.html } + */ interface Sync { User: User; Session: Session; diff --git a/types/redux-action/redux-action-tests.ts b/types/redux-action/redux-action-tests.ts index cad92bba34..252239e23e 100644 --- a/types/redux-action/redux-action-tests.ts +++ b/types/redux-action/redux-action-tests.ts @@ -1,4 +1,3 @@ - import * as ReduxAction from 'redux-action'; import * as ReduxThunk from 'redux-thunk'; import * as Redux from 'redux'; diff --git a/types/redux-actions/redux-actions-tests.ts b/types/redux-actions/redux-actions-tests.ts index 11fa7adf13..f2d7cef7d1 100644 --- a/types/redux-actions/redux-actions-tests.ts +++ b/types/redux-actions/redux-actions-tests.ts @@ -131,9 +131,7 @@ ReduxActions.handleAction(act3, (state, action) => { return { hello: action.payload.s }; }, {hello: 'greetings'}); -ReduxActions.handleAction(ReduxActions.combineActions(act, act3, act2), (state, action) => { - -}, 0); +ReduxActions.handleAction(ReduxActions.combineActions(act, act3, act2), (state, action) => {}, 0); /* can't do this until it lands in 2.2, HKTs ReduxActions.handleAction(act, (state, action) => { diff --git a/types/redux-auth-wrapper/index.d.ts b/types/redux-auth-wrapper/index.d.ts index ffde27da52..53029c1b15 100644 --- a/types/redux-auth-wrapper/index.d.ts +++ b/types/redux-auth-wrapper/index.d.ts @@ -16,16 +16,16 @@ interface InjectedProps { export interface AuthWrapperConfig { allowRedirectBack?: boolean | ((location: Location, redirectPath: string) => boolean); - authenticatingSelector?: (state: State, ownProps?: Props) => boolean; - authSelector: (state: State, ownProps?: Props) => AuthData; + authenticatingSelector?(state: State, ownProps?: Props): boolean; + authSelector(state: State, ownProps?: Props): AuthData; FailureComponent?: ReactType; failureRedirectPath?: string | ((state: State, ownProps?: Props) => string); LoadingComponent?: ReactType; redirectQueryParamName?: string; wrapperDisplayName?: string; - predicate?: (authData: AuthData) => boolean; - propMapper?: (ownProps: Props) => InjectedProps & Props; - redirectAction?: (...args: any[]) => Action; + predicate?(authData: AuthData): boolean; + propMapper?(ownProps: Props): InjectedProps & Props; + redirectAction?(...args: any[]): Action; } type AuthDecorator = (component: ComponentConstructor) => ComponentClass; diff --git a/types/redux-auth-wrapper/redux-auth-wrapper-tests.tsx b/types/redux-auth-wrapper/redux-auth-wrapper-tests.tsx index a6d363dc06..c8c52335a6 100644 --- a/types/redux-auth-wrapper/redux-auth-wrapper-tests.tsx +++ b/types/redux-auth-wrapper/redux-auth-wrapper-tests.tsx @@ -5,10 +5,10 @@ import { UserAuthWrapper } from "redux-auth-wrapper"; const Auth = UserAuthWrapper({ allowRedirectBack: true, authenticatingSelector(state: any) { - return state.auth.loading + return state.auth.loading; }, authSelector(state: any) { - return state.auth + return state.auth; }, FailureComponent: () => (
    ), failureRedirectPath: "/401", @@ -16,7 +16,7 @@ const Auth = UserAuthWrapper({ redirectAction: () => ({ type : "redirect" }), redirectQueryParamName: "next", predicate(authData: any) { - return authData.authorized + return authData.authorized; }, wrapperDisplayName: "TestAuth" }); diff --git a/types/redux-persist-transform-encrypt/redux-persist-transform-encrypt-tests.ts b/types/redux-persist-transform-encrypt/redux-persist-transform-encrypt-tests.ts index 76dc7985bd..fdbe7f60d8 100644 --- a/types/redux-persist-transform-encrypt/redux-persist-transform-encrypt-tests.ts +++ b/types/redux-persist-transform-encrypt/redux-persist-transform-encrypt-tests.ts @@ -1,15 +1,15 @@ -import { createStore, Reducer, Store } from "redux" -import { createPersistor, Transform } from "redux-persist" -import { EncryptorConfig } from "redux-persist-transform-encrypt" -import createEncryptor from "redux-persist-transform-encrypt" -import createAsyncEncryptor from "redux-persist-transform-encrypt/async" +import { createStore, Reducer, Store } from "redux"; +import { createPersistor, Transform } from "redux-persist"; +import { EncryptorConfig } from "redux-persist-transform-encrypt"; +import createEncryptor from "redux-persist-transform-encrypt"; +import createAsyncEncryptor from "redux-persist-transform-encrypt/async"; -const reducer: Reducer = (state: any, action: any) => ({ state, action }) +const reducer: Reducer = (state: any, action: any) => ({ state, action }); -const config: EncryptorConfig = { secretKey : "foo" } -const encryptor: Transform = createEncryptor(config) -const asyncEncryptor: Transform = createAsyncEncryptor(config) +const config: EncryptorConfig = { secretKey : "foo" }; +const encryptor: Transform = createEncryptor(config); +const asyncEncryptor: Transform = createAsyncEncryptor(config); -const store: Store = createStore(reducer) +const store: Store = createStore(reducer); -createPersistor(store, { transforms : [encryptor, asyncEncryptor] }) +createPersistor(store, { transforms : [encryptor, asyncEncryptor] }); diff --git a/types/redux-persist-transform-filter/redux-persist-transform-filter-tests.ts b/types/redux-persist-transform-filter/redux-persist-transform-filter-tests.ts index 737e4a70a7..67226438e5 100644 --- a/types/redux-persist-transform-filter/redux-persist-transform-filter-tests.ts +++ b/types/redux-persist-transform-filter/redux-persist-transform-filter-tests.ts @@ -1,15 +1,15 @@ -import { createStore, Reducer, Store } from "redux" -import { createPersistor, Transform } from "redux-persist" -import createFilter from "redux-persist-transform-filter" +import { createStore, Reducer, Store } from "redux"; +import { createPersistor, Transform } from "redux-persist"; +import createFilter from "redux-persist-transform-filter"; -const reducer: Reducer = (state: any, action: any) => ({ state, action }) +const reducer: Reducer = (state: any, action: any) => ({ state, action }); const filter: Transform = createFilter( "foo", ["foo.bar"], ["fizz.buzz"] -) +); -const store: Store = createStore(reducer) +const store: Store = createStore(reducer); -createPersistor(store, { transforms : [filter] }) +createPersistor(store, { transforms : [filter] }); diff --git a/types/redux-ui/index.d.ts b/types/redux-ui/index.d.ts index 1c3468233d..c30f3d1af9 100644 --- a/types/redux-ui/index.d.ts +++ b/types/redux-ui/index.d.ts @@ -21,7 +21,7 @@ export interface uiParams { state: UIStateShape; // optional mergeProps passed to react-redux' @connect - mergeProps?: (stateProps: any, dispatchProps: any, ownProps: any) => any; + mergeProps?(stateProps: any, dispatchProps: any, ownProps: any): any; // optional `options` passed to react-redux @connect options?: { diff --git a/types/redux-ui/redux-ui-tests.ts b/types/redux-ui/redux-ui-tests.ts index 352e70576d..049c807af7 100644 --- a/types/redux-ui/redux-ui-tests.ts +++ b/types/redux-ui/redux-ui-tests.ts @@ -30,4 +30,3 @@ class Root extends React.Component, {}> { Redux.combineReducers({ ui: reducer, }); - diff --git a/types/requirejs/index.d.ts b/types/requirejs/index.d.ts index ac116494f3..b2d5879e85 100644 --- a/types/requirejs/index.d.ts +++ b/types/requirejs/index.d.ts @@ -48,7 +48,7 @@ interface RequireError extends Error { /** * Required modules. **/ - requireModules: string[]; + requireModules: string[] | null; /** * The original error, if there is one (might be null). diff --git a/types/restify-plugins/index.d.ts b/types/restify-plugins/index.d.ts index 68c9131c3b..d5009bce78 100644 --- a/types/restify-plugins/index.d.ts +++ b/types/restify-plugins/index.d.ts @@ -137,7 +137,7 @@ interface BodyParserOptions { * A callback to handle any multipart part which is not a file. * If this is omitted, the default handler is invoked which may or may not map the parts into req.params, depending on the mapParams-option. */ - multipartHandler?: () => void; + multipartHandler?(): void; /** * A callback to handle any multipart file. @@ -145,7 +145,7 @@ interface BodyParserOptions { * This typically happens when a browser sends a form and there is a parameter similar to . * If this is not provided, the default behaviour is to map the contents into req.params. */ - multipartFileHandler?: () => void; + multipartFileHandler?(): void; /** * If you want the uploaded files to include the extensions of the original files (multipart uploads only). Does nothing if multipartFileHandler is defined. @@ -367,9 +367,9 @@ type TMetricsCallback = 'close' | 'aborted' | undefined; interface MetricsCallbackOptions { /** - * Status code of the response. Can be undefined in the case of an `uncaughtException`. - * Otherwise, in most normal scenarios, even calling `res.send()` or `res.end()` should result in a 200 by default. - */ + * Status code of the response. Can be undefined in the case of an `uncaughtException`. + * Otherwise, in most normal scenarios, even calling `res.send()` or `res.end()` should result in a 200 by default. + */ statusCode: number; /** diff --git a/types/rheostat/index.d.ts b/types/rheostat/index.d.ts index 372e5c6f1b..86312c4fb3 100644 --- a/types/rheostat/index.d.ts +++ b/types/rheostat/index.d.ts @@ -20,13 +20,13 @@ export interface PublicState { } export interface Events { - onClick?: () => any; - onChange?: (publicState: PublicState) => any; - onKeyPress?: () => any; - onSliderDragEnd?: () => any; - onSliderDragMove?: () => any; - onSliderDragStart?: () => any; - onValuesUpdated?: (publicState: PublicState) => any; + onClick?(): any; + onChange?(publicState: PublicState): any; + onKeyPress?(): any; + onSliderDragEnd?(): any; + onSliderDragMove?(): any; + onSliderDragStart?(): any; + onValuesUpdated?(publicState: PublicState): any; } export interface Props extends Events { @@ -46,4 +46,3 @@ export interface Props extends Events { } export default class Rheostat extends React.Component {} - diff --git a/types/rrule/index.d.ts b/types/rrule/index.d.ts index 038bde2736..3915865392 100644 --- a/types/rrule/index.d.ts +++ b/types/rrule/index.d.ts @@ -19,9 +19,9 @@ declare module "rrule" { declare namespace RRule { /** - * see - * The only required option is `freq`, one of RRule.YEARLY, RRule.MONTHLY, ... - */ + * see + * The only required option is `freq`, one of RRule.YEARLY, RRule.MONTHLY, ... + */ interface Options { freq: RRule.Frequency; dtstart?: Date; @@ -55,10 +55,10 @@ declare namespace RRule { declare class RRule { /** - * @param {Object?} options - see - * The only required option is `freq`, one of RRule.YEARLY, RRule.MONTHLY, ... - * @constructor - */ + * @param {Object?} options - see + * The only required option is `freq`, one of RRule.YEARLY, RRule.MONTHLY, ... + * @constructor + */ constructor(options: RRule.Options, noCache?: boolean); options: RRule.Options; @@ -66,55 +66,55 @@ declare class RRule { origOptions: RRule.Options; /** - * Returns the first recurrence after the given datetime instance. - * The inc keyword defines what happens if dt is an occurrence. - * With inc == True, if dt itself is an occurrence, it will be returned. - * @return Date or null - */ + * Returns the first recurrence after the given datetime instance. + * The inc keyword defines what happens if dt is an occurrence. + * With inc == True, if dt itself is an occurrence, it will be returned. + * @return Date or null + */ after(dt: Date, inc?: boolean): Date; /** - * @param {Function} iterator - optional function that will be called - * on each date that is added. It can return false - * to stop the iteration. - * @return Array containing all recurrences. - */ + * @param {Function} iterator - optional function that will be called + * on each date that is added. It can return false + * to stop the iteration. + * @return Array containing all recurrences. + */ all(iterator?: (date: Date, index?: number) => void): Date[]; /** - * Returns all the occurrences of the rrule between after and before. - * The inc keyword defines what happens if after and/or before are - * themselves occurrences. With inc == True, they will be included in the - * list, if they are found in the recurrence set. - * @return Array - */ + * Returns all the occurrences of the rrule between after and before. + * The inc keyword defines what happens if after and/or before are + * themselves occurrences. With inc == True, they will be included in the + * list, if they are found in the recurrence set. + * @return Array + */ between(a: Date, b: Date, inc?: boolean, iterator?: (date: Date, index: number) => void): Date[]; /** - * Returns the last recurrence before the given datetime instance. - * The inc keyword defines what happens if dt is an occurrence. - * With inc == True, if dt itself is an occurrence, it will be returned. - * @return Date or null - */ + * Returns the last recurrence before the given datetime instance. + * The inc keyword defines what happens if dt is an occurrence. + * With inc == True, if dt itself is an occurrence, it will be returned. + * @return Date or null + */ before(dt: Date, inc?: boolean): Date; /** - * Returns the number of recurrences in this set. It will have go trough - * the whole recurrence, if this hasn't been done before. - */ + * Returns the number of recurrences in this set. It will have go trough + * the whole recurrence, if this hasn't been done before. + */ count(): number; /** - * Converts the rrule into its string representation - * @see - * @return String - */ + * Converts the rrule into its string representation + * @see + * @return String + */ toString(): string; /** - * Will convert all rules described in nlp:ToText - * to text. - */ + * Will convert all rules described in nlp:ToText + * to text. + */ toText(gettext?: (str: string) => string, language?: any): string; isFullyConvertibleToText(): boolean; @@ -165,11 +165,10 @@ declare namespace RRule { class RRuleSet extends RRule { /** - * - * @param {Boolean?} noCache - * The same stratagy as RRule on cache, default to false - * @constructor - */ + * @param {Boolean?} noCache + * The same stratagy as RRule on cache, default to false + * @constructor + */ constructor(noCache?: boolean); rrule(rrule: RRule): void; rdate(date: Date): void; @@ -177,13 +176,13 @@ declare namespace RRule { exdate(date: Date): void; valueOf(): string[]; /** - * to generate recurrence field sush as: - * ["RRULE:FREQ=YEARLY;COUNT=2;BYDAY=TU;DTSTART=19970902T010000Z","RRULE:FREQ=YEARLY;COUNT=1;BYDAY=TH;DTSTART=19970902T010000Z"] - */ + * to generate recurrence field sush as: + * ["RRULE:FREQ=YEARLY;COUNT=2;BYDAY=TU;DTSTART=19970902T010000Z","RRULE:FREQ=YEARLY;COUNT=1;BYDAY=TH;DTSTART=19970902T010000Z"] + */ toString(): string; /** - * Create a new RRuleSet Object completely base on current instance - */ + * Create a new RRuleSet Object completely base on current instance + */ clone(): RRuleSet; } } diff --git a/types/rx-core-binding/index.d.ts b/types/rx-core-binding/index.d.ts index 1f51c54e1c..e8ba93bd3a 100644 --- a/types/rx-core-binding/index.d.ts +++ b/types/rx-core-binding/index.d.ts @@ -65,31 +65,31 @@ declare namespace Rx { publish(): ConnectableObservable; publish(selector: (source: ConnectableObservable) => Observable): Observable; /** - * Returns an observable sequence that shares a single subscription to the underlying sequence. - * This operator is a specialization of publish which creates a subscription when the number of observers goes from zero to one, - * then shares that subscription with all subsequent observers until the number of observers returns to zero, at which point the subscription is disposed. - * - * @example - * var res = source.share(); - * - * @returns An observable sequence that contains the elements of a sequence produced by multicasting the source sequence. - */ + * Returns an observable sequence that shares a single subscription to the underlying sequence. + * This operator is a specialization of publish which creates a subscription when the number of observers goes from zero to one, + * then shares that subscription with all subsequent observers until the number of observers returns to zero, at which point the subscription is disposed. + * + * @example + * var res = source.share(); + * + * @returns An observable sequence that contains the elements of a sequence produced by multicasting the source sequence. + */ share(): Observable; publishLast(): ConnectableObservable; publishLast(selector: (source: ConnectableObservable) => Observable): Observable; publishValue(initialValue: T): ConnectableObservable; publishValue(selector: (source: ConnectableObservable) => Observable, initialValue: T): Observable; /** - * Returns an observable sequence that shares a single subscription to the underlying sequence and starts with an initialValue. - * This operator is a specialization of publishValue which creates a subscription when the number of observers goes from zero to one, - * then shares that subscription with all subsequent observers until the number of observers returns to zero, at which point the subscription is disposed. - * - * @example - * var res = source.shareValue(42); - * - * @param initialValue Initial value received by observers upon subscription. - * @returns An observable sequence that contains the elements of a sequence produced by multicasting the source sequence. - */ + * Returns an observable sequence that shares a single subscription to the underlying sequence and starts with an initialValue. + * This operator is a specialization of publishValue which creates a subscription when the number of observers goes from zero to one, + * then shares that subscription with all subsequent observers until the number of observers returns to zero, at which point the subscription is disposed. + * + * @example + * var res = source.shareValue(42); + * + * @param initialValue Initial value received by observers upon subscription. + * @returns An observable sequence that contains the elements of a sequence produced by multicasting the source sequence. + */ shareValue(initialValue: T): Observable; replay(selector?: boolean, bufferSize?: number, window?: number, scheduler?: IScheduler): ConnectableObservable; // hack to catch first omitted parameter replay(selector: (source: ConnectableObservable) => Observable, bufferSize?: number, window?: number, scheduler?: IScheduler): Observable; diff --git a/types/rx-core/index.d.ts b/types/rx-core/index.d.ts index f922b1f083..dab3d10fa5 100644 --- a/types/rx-core/index.d.ts +++ b/types/rx-core/index.d.ts @@ -5,8 +5,8 @@ declare namespace Rx { /** - * Promise A+ - */ + * Promise A+ + */ interface IPromise { then(onFulfilled: (value: T) => IPromise, onRejected: (reason: any) => IPromise): IPromise; then(onFulfilled: (value: T) => IPromise, onRejected?: (reason: any) => R): IPromise; @@ -30,10 +30,10 @@ declare namespace Rx { interface ObserverStatic { /** - * Schedules the invocation of observer methods on the given scheduler. - * @param scheduler Scheduler to schedule observer messages on. - * @returns Observer whose messages are scheduled on the given scheduler. - */ + * Schedules the invocation of observer methods on the given scheduler. + * @param scheduler Scheduler to schedule observer messages on. + * @returns Observer whose messages are scheduled on the given scheduler. + */ notifyOn(scheduler: IScheduler): Observer; } diff --git a/types/rx-lite-async/index.d.ts b/types/rx-lite-async/index.d.ts index d912f56d39..94117a1562 100644 --- a/types/rx-lite-async/index.d.ts +++ b/types/rx-lite-async/index.d.ts @@ -8,10 +8,10 @@ declare namespace Rx { interface ObservableStatic { /** - * Invokes the asynchronous function, surfacing the result through an observable sequence. - * @param functionAsync Asynchronous function which returns a Promise to run. - * @returns An observable sequence exposing the function's result value, or an exception. - */ + * Invokes the asynchronous function, surfacing the result through an observable sequence. + * @param functionAsync Asynchronous function which returns a Promise to run. + * @returns An observable sequence exposing the function's result value, or an exception. + */ startAsync(functionAsync: () => IPromise): Observable; start(func: () => T, context?: any, scheduler?: IScheduler): Observable; diff --git a/types/rx-lite-backpressure/index.d.ts b/types/rx-lite-backpressure/index.d.ts index d5039c2667..fa997f03c6 100644 --- a/types/rx-lite-backpressure/index.d.ts +++ b/types/rx-lite-backpressure/index.d.ts @@ -8,32 +8,32 @@ declare namespace Rx { interface Observable { /** - * Pauses the underlying observable sequence based upon the observable sequence which yields true/false. - * @example - * var pauser = new Rx.Subject(); - * var source = Rx.Observable.interval(100).pausable(pauser); - * @param pauser The observable sequence used to pause the underlying sequence. - * @returns The observable sequence which is paused based upon the pauser. - */ + * Pauses the underlying observable sequence based upon the observable sequence which yields true/false. + * @example + * var pauser = new Rx.Subject(); + * var source = Rx.Observable.interval(100).pausable(pauser); + * @param pauser The observable sequence used to pause the underlying sequence. + * @returns The observable sequence which is paused based upon the pauser. + */ pausable(pauser?: Observable): PausableObservable; /** - * Pauses the underlying observable sequence based upon the observable sequence which yields true/false, - * and yields the values that were buffered while paused. - * @example - * var pauser = new Rx.Subject(); - * var source = Rx.Observable.interval(100).pausableBuffered(pauser); - * @param pauser The observable sequence used to pause the underlying sequence. - * @returns The observable sequence which is paused based upon the pauser. - */ + * Pauses the underlying observable sequence based upon the observable sequence which yields true/false, + * and yields the values that were buffered while paused. + * @example + * var pauser = new Rx.Subject(); + * var source = Rx.Observable.interval(100).pausableBuffered(pauser); + * @param pauser The observable sequence used to pause the underlying sequence. + * @returns The observable sequence which is paused based upon the pauser. + */ pausableBuffered(pauser?: Observable): PausableObservable; /** - * Attaches a controller to the observable sequence with the ability to queue. - * @example - * var source = Rx.Observable.interval(100).controlled(); - * source.request(3); // Reads 3 values - */ + * Attaches a controller to the observable sequence with the ability to queue. + * @example + * var source = Rx.Observable.interval(100).controlled(); + * source.request(3); // Reads 3 values + */ controlled(enableQueue?: boolean): ControlledObservable; } diff --git a/types/rx-lite-coincidence/index.d.ts b/types/rx-lite-coincidence/index.d.ts index 3dc9f4c1be..3682126071 100644 --- a/types/rx-lite-coincidence/index.d.ts +++ b/types/rx-lite-coincidence/index.d.ts @@ -28,26 +28,26 @@ declare namespace Rx { buffer(bufferOpenings: Observable, bufferClosingSelector: () => Observable): Observable; /** - * Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - * The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as a pair. - * The argument passed to the N-1th triggering is held in hidden internal state until the Nth triggering occurs. - * @returns An observable that triggers on successive pairs of observations from the input observable as an array. - */ + * Returns a new observable that triggers on the second and subsequent triggerings of the input observable. + * The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as a pair. + * The argument passed to the N-1th triggering is held in hidden internal state until the Nth triggering occurs. + * @returns An observable that triggers on successive pairs of observations from the input observable as an array. + */ pairwise(): Observable; /** - * Returns two observables which partition the observations of the source by the given function. - * The first will trigger observations for those values for which the predicate returns true. - * The second will trigger observations for those values where the predicate returns false. - * The predicate is executed once for each subscribed observer. - * Both also propagate all error observations arising from the source and each completes - * when the source completes. - * @param predicate - * The function to determine which output Observable will trigger a particular observation. - * @returns - * An array of observables. The first triggers when the predicate returns true, - * and the second triggers when the predicate returns false. - */ + * Returns two observables which partition the observations of the source by the given function. + * The first will trigger observations for those values for which the predicate returns true. + * The second will trigger observations for those values where the predicate returns false. + * The predicate is executed once for each subscribed observer. + * Both also propagate all error observations arising from the source and each completes + * when the source completes. + * @param predicate + * The function to determine which output Observable will trigger a particular observation. + * @returns + * An array of observables. The first triggers when the predicate returns true, + * and the second triggers when the predicate returns false. + */ partition(predicate: (value: T, index: number, source: Observable) => boolean, thisArg?: any): Array>; } } diff --git a/types/rx-lite-time/index.d.ts b/types/rx-lite-time/index.d.ts index 01fadea822..e5abaf3832 100644 --- a/types/rx-lite-time/index.d.ts +++ b/types/rx-lite-time/index.d.ts @@ -15,8 +15,8 @@ declare namespace Rx { debounceWithSelector(debounceDurationSelector: (item: T) => Observable): Observable; /** - * @deprecated use #debounceWithSelector instead. - */ + * @deprecated use #debounceWithSelector instead. + */ throttleWithSelector(debounceDurationSelector: (item: T) => Observable): Observable; skipLastWithTime(duration: number, scheduler?: IScheduler): Observable; diff --git a/types/rx-lite/index.d.ts b/types/rx-lite/index.d.ts index d56e4e473c..331145e0dd 100644 --- a/types/rx-lite/index.d.ts +++ b/types/rx-lite/index.d.ts @@ -352,32 +352,32 @@ declare namespace Rx { selectConcat(sequence: Observable): Observable; /** - * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then - * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. - * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. - * @param [thisArg] Object to use as this when executing callback. - * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences - * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. - */ + * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then + * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. + * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. + * @param [thisArg] Object to use as this when executing callback. + * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences + * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. + */ selectSwitch(selector: (value: T, index: number, source: Observable) => Observable, thisArg?: any): Observable; /** - * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then - * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. - * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. - * @param [thisArg] Object to use as this when executing callback. - * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences - * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. - */ + * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then + * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. + * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. + * @param [thisArg] Object to use as this when executing callback. + * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences + * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. + */ flatMapLatest(selector: (value: T, index: number, source: Observable) => Observable, thisArg?: any): Observable; // alias for selectSwitch /** - * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then - * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. - * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. - * @param [thisArg] Object to use as this when executing callback. - * @since 2.2.28 - * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences - * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. - */ + * Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then + * transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence. + * @param selector A transform function to apply to each source element; the second parameter of the function represents the index of the source element. + * @param [thisArg] Object to use as this when executing callback. + * @since 2.2.28 + * @returns An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences + * and that at any point in time produces the elements of the most recent inner observable sequence that has been received. + */ switchMap(selector: (value: T, index: number, source: Observable) => TResult, thisArg?: any): Observable; // alias for selectSwitch skip(count: number): Observable; @@ -388,46 +388,46 @@ declare namespace Rx { filter(predicate: (value: T, index: number, source: Observable) => boolean, thisArg?: any): Observable; // alias for where /** - * Converts an existing observable sequence to an ES6 Compatible Promise - * @example - * var promise = Rx.Observable.return(42).toPromise(RSVP.Promise); - * @param promiseCtor The constructor of the promise. - * @returns An ES6 compatible promise with the last value from the observable sequence. - */ + * Converts an existing observable sequence to an ES6 Compatible Promise + * @example + * var promise = Rx.Observable.return(42).toPromise(RSVP.Promise); + * @param promiseCtor The constructor of the promise. + * @returns An ES6 compatible promise with the last value from the observable sequence. + */ toPromise>(promiseCtor: { new (resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void): TPromise; }): TPromise; /** - * Converts an existing observable sequence to an ES6 Compatible Promise - * @example - * var promise = Rx.Observable.return(42).toPromise(RSVP.Promise); - * - * // With config - * Rx.config.Promise = RSVP.Promise; - * var promise = Rx.Observable.return(42).toPromise(); - * @param [promiseCtor] The constructor of the promise. If not provided, it looks for it in Rx.config.Promise. - * @returns An ES6 compatible promise with the last value from the observable sequence. - */ + * Converts an existing observable sequence to an ES6 Compatible Promise + * @example + * var promise = Rx.Observable.return(42).toPromise(RSVP.Promise); + * + * // With config + * Rx.config.Promise = RSVP.Promise; + * var promise = Rx.Observable.return(42).toPromise(); + * @param [promiseCtor] The constructor of the promise. If not provided, it looks for it in Rx.config.Promise. + * @returns An ES6 compatible promise with the last value from the observable sequence. + */ toPromise(promiseCtor?: { new (resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void): IPromise; }): IPromise; // Experimental Flattening /** - * Performs a exclusive waiting for the first to finish before subscribing to another observable. - * Observables that come in between subscriptions will be dropped on the floor. - * Can be applied on `Observable>` or `Observable>`. - * @since 2.2.28 - * @returns A exclusive observable with only the results that happen when subscribed. - */ + * Performs a exclusive waiting for the first to finish before subscribing to another observable. + * Observables that come in between subscriptions will be dropped on the floor. + * Can be applied on `Observable>` or `Observable>`. + * @since 2.2.28 + * @returns A exclusive observable with only the results that happen when subscribed. + */ exclusive(): Observable; /** - * Performs a exclusive map waiting for the first to finish before subscribing to another observable. - * Observables that come in between subscriptions will be dropped on the floor. - * Can be applied on `Observable>` or `Observable>`. - * @since 2.2.28 - * @param selector Selector to invoke for every item in the current subscription. - * @param [thisArg] An optional context to invoke with the selector parameter. - * @returns {An exclusive observable with only the results that happen when subscribed. - */ + * Performs a exclusive map waiting for the first to finish before subscribing to another observable. + * Observables that come in between subscriptions will be dropped on the floor. + * Can be applied on `Observable>` or `Observable>`. + * @since 2.2.28 + * @param selector Selector to invoke for every item in the current subscription. + * @param [thisArg] An optional context to invoke with the selector parameter. + * @returns {An exclusive observable with only the results that happen when subscribed. + */ exclusiveMap(selector: (value: I, index: number, source: Observable) => R, thisArg?: any): Observable; publish(): ConnectableObservable; @@ -447,46 +447,46 @@ declare namespace Rx { empty(scheduler?: IScheduler): Observable; /** - * This method creates a new Observable sequence from an array object. - * @param array An array-like or iterable object to convert to an Observable sequence. - * @param mapFn Map function to call on every element of the array. - * @param [thisArg] The context to use calling the mapFn if provided. - * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. - */ + * This method creates a new Observable sequence from an array object. + * @param array An array-like or iterable object to convert to an Observable sequence. + * @param mapFn Map function to call on every element of the array. + * @param [thisArg] The context to use calling the mapFn if provided. + * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. + */ from(array: T[], mapFn: (value: T, index: number) => TResult, thisArg?: any, scheduler?: IScheduler): Observable; /** - * This method creates a new Observable sequence from an array object. - * @param array An array-like or iterable object to convert to an Observable sequence. - * @param [mapFn] Map function to call on every element of the array. - * @param [thisArg] The context to use calling the mapFn if provided. - * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. - */ + * This method creates a new Observable sequence from an array object. + * @param array An array-like or iterable object to convert to an Observable sequence. + * @param [mapFn] Map function to call on every element of the array. + * @param [thisArg] The context to use calling the mapFn if provided. + * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. + */ from(array: T[], mapFn?: (value: T, index: number) => T, thisArg?: any, scheduler?: IScheduler): Observable; /** - * This method creates a new Observable sequence from an array-like object. - * @param array An array-like or iterable object to convert to an Observable sequence. - * @param mapFn Map function to call on every element of the array. - * @param [thisArg] The context to use calling the mapFn if provided. - * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. - */ + * This method creates a new Observable sequence from an array-like object. + * @param array An array-like or iterable object to convert to an Observable sequence. + * @param mapFn Map function to call on every element of the array. + * @param [thisArg] The context to use calling the mapFn if provided. + * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. + */ from(array: { length: number; [index: number]: T; }, mapFn: (value: T, index: number) => TResult, thisArg?: any, scheduler?: IScheduler): Observable; /** - * This method creates a new Observable sequence from an array-like object. - * @param array An array-like or iterable object to convert to an Observable sequence. - * @param [mapFn] Map function to call on every element of the array. - * @param [thisArg] The context to use calling the mapFn if provided. - * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. - */ + * This method creates a new Observable sequence from an array-like object. + * @param array An array-like or iterable object to convert to an Observable sequence. + * @param [mapFn] Map function to call on every element of the array. + * @param [thisArg] The context to use calling the mapFn if provided. + * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. + */ from(array: { length: number; [index: number]: T; }, mapFn?: (value: T, index: number) => T, thisArg?: any, scheduler?: IScheduler): Observable; /** - * This method creates a new Observable sequence from an array-like or iterable object. - * @param array An array-like or iterable object to convert to an Observable sequence. - * @param [mapFn] Map function to call on every element of the array. - * @param [thisArg] The context to use calling the mapFn if provided. - * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. - */ + * This method creates a new Observable sequence from an array-like or iterable object. + * @param array An array-like or iterable object to convert to an Observable sequence. + * @param [mapFn] Map function to call on every element of the array. + * @param [thisArg] The context to use calling the mapFn if provided. + * @param [scheduler] Optional scheduler to use for scheduling. If not provided, defaults to Scheduler.currentThread. + */ from(iterable: any, mapFn?: (value: any, index: number) => T, thisArg?: any, scheduler?: IScheduler): Observable; fromArray(array: T[], scheduler?: IScheduler): Observable; @@ -496,23 +496,23 @@ declare namespace Rx { never(): Observable; /** - * This method creates a new Observable instance with a variable number of arguments, regardless of number or type of the arguments. - * - * @example - * var res = Rx.Observable.of(1, 2, 3); - * @since 2.2.28 - * @returns The observable sequence whose elements are pulled from the given arguments. - */ + * This method creates a new Observable instance with a variable number of arguments, regardless of number or type of the arguments. + * + * @example + * var res = Rx.Observable.of(1, 2, 3); + * @since 2.2.28 + * @returns The observable sequence whose elements are pulled from the given arguments. + */ of(...values: T[]): Observable; /** - * This method creates a new Observable instance with a variable number of arguments, regardless of number or type of the arguments. - * @example - * var res = Rx.Observable.ofWithScheduler(Rx.Scheduler.timeout, 1, 2, 3); - * @since 2.2.28 - * @param [scheduler] A scheduler to use for scheduling the arguments. - * @returns The observable sequence whose elements are pulled from the given arguments. - */ + * This method creates a new Observable instance with a variable number of arguments, regardless of number or type of the arguments. + * @example + * var res = Rx.Observable.ofWithScheduler(Rx.Scheduler.timeout, 1, 2, 3); + * @since 2.2.28 + * @param [scheduler] A scheduler to use for scheduling the arguments. + * @returns The observable sequence whose elements are pulled from the given arguments. + */ ofWithScheduler(scheduler?: IScheduler, ...values: T[]): Observable; range(start: number, count: number, scheduler?: IScheduler): Observable; repeat(value: T, repeatCount?: number, scheduler?: IScheduler): Observable; @@ -582,10 +582,10 @@ declare namespace Rx { zipArray(sources: (Observable | IPromise)[]): Observable; /** - * Converts a Promise to an Observable sequence - * @param promise An ES6 Compliant promise. - * @returns An Observable sequence which wraps the existing promise success and failure. - */ + * Converts a Promise to an Observable sequence + * @param promise An ES6 Compliant promise. + * @returns An Observable sequence which wraps the existing promise success and failure. + */ fromPromise(promise: IPromise): Observable; prototype: any; @@ -599,8 +599,8 @@ declare namespace Rx { declare namespace Rx { namespace config { /** - * Configuration option to determine whether to use native events only - */ + * Configuration option to determine whether to use native events only + */ const useNativeEvents: boolean; } diff --git a/types/safe-regex/safe-regex-tests.ts b/types/safe-regex/safe-regex-tests.ts index a3c0b3a420..f67f04653b 100644 --- a/types/safe-regex/safe-regex-tests.ts +++ b/types/safe-regex/safe-regex-tests.ts @@ -1,2 +1,2 @@ import safe = require('safe-regex'); -console.log(safe("regex")); \ No newline at end of file +console.log(safe("regex")); diff --git a/types/selenium-webdriver/tslint.json b/types/selenium-webdriver/tslint.json index f38c4dfc69..d8dafaf0cc 100644 --- a/types/selenium-webdriver/tslint.json +++ b/types/selenium-webdriver/tslint.json @@ -1,10 +1,13 @@ { "extends": "../tslint.json", "rules": { + "align": false, "ban-types": false, "callable-types": false, "interface-name": [false], + "jsdoc-format": false, "no-empty-interface": false, + "semicolon": false, "unified-signatures": false } } diff --git a/types/semantic-ui/index.d.ts b/types/semantic-ui/index.d.ts index bdfa5c2249..96d660d82b 100644 --- a/types/semantic-ui/index.d.ts +++ b/types/semantic-ui/index.d.ts @@ -5,6 +5,29 @@ /// +interface JQueryStatic { + accordion: { settings: SemanticUI.AccordionSettings }; + checkbox: { settings: SemanticUI.CheckboxSettings }; + dimmer: { settings: SemanticUI.DimmerSettings }; + dropdown: { settings: SemanticUI.DropdownSettings }; + embed: { settings: SemanticUI.EmbedSettings }; + modal: { settings: SemanticUI.ModalSettings }; + nag: { settings: SemanticUI.NagSettings }; + popup: { settings: SemanticUI.PopupSettings }; + progress: { settings: SemanticUI.ProgressSettings }; + rating: { settings: SemanticUI.RatingSettings }; + search: { settings: SemanticUI.SearchSettings }; + shape: { settings: SemanticUI.ShapeSettings }; + sidebar: { settings: SemanticUI.SidebarSettings }; + sticky: { settings: SemanticUI.StickySettings }; + tab: { settings: SemanticUI.TabSettings }; + transition: { settings: SemanticUI.TransitionSettings }; + + api: { settings: SemanticUI.ApiSettings }; + form: { settings: SemanticUI.FormSettings }; + visibility: { settings: SemanticUI.VisibilitySettings }; +} + interface JQuery { // TODO: Do all modules have a 'setting' behavior? @@ -719,7 +742,7 @@ interface JQuery { /** * Search for value currently set in search input */ - search(behavior: 'query'): JQuery; + search(behavior: 'query', callback?: () => void): JQuery; /** * Displays message in search results with text, using template matching type */ @@ -739,7 +762,7 @@ interface JQuery { /** * Search remote endpoint for specified query and display results */ - search(behavior: 'search remote', query: string): JQuery; + search(behavior: 'search remote', query: string, callback?: () => void): JQuery; /** * Search object for specified query and return results */ @@ -791,11 +814,11 @@ interface JQuery { /** * Shows results container */ - search(behavior: 'show results'): JQuery; + search(behavior: 'show results', callback?: () => void): JQuery; /** * Hides results container */ - search(behavior: 'hide results'): JQuery; + search(behavior: 'hide results', callback?: () => void): JQuery; /** * Generates results using parser specified by settings.template */ @@ -1301,7 +1324,7 @@ declare namespace SemanticUI { /** * Event namespace. Makes sure module teardown does not effect other events attached to an element. */ - namespace?: string; + namespace?: string; // endregion @@ -1394,23 +1417,23 @@ declare namespace SemanticUI { /** * Callback before element opens */ - onOpening?: (this: JQuery) => void; + onOpening?(this: JQuery): void; /** * Callback after element is open */ - onOpen?: (this: JQuery) => void; + onOpen?(this: JQuery): void; /** * Callback before element closes */ - onClosing?: (this: JQuery) => void; + onClosing?(this: JQuery): void; /** * Callback after element is closed */ - onClose?: (this: JQuery) => void; + onClose?(this: JQuery): void; /** * Callback on element open or close */ - onChange?: (this: JQuery) => void; + onChange?(this: JQuery): void; // endregion @@ -1495,59 +1518,59 @@ declare namespace SemanticUI { /** * Callback after a checkbox is either checked or unchecked. */ - onChange?: (this: HTMLElement) => void; + onChange?(this: HTMLElement): void; /** * Callback after a checkbox is checked. */ - onChecked?: (this: HTMLElement) => void; + onChecked?(this: HTMLElement): void; /** * Callback after a checkbox is set to undeterminate. */ - onIndeterminate?: (this: HTMLElement) => void; + onIndeterminate?(this: HTMLElement): void; /** * Callback after a checkbox is set to determinate. */ - onDeterminate?: (this: HTMLElement) => void; + onDeterminate?(this: HTMLElement): void; /** * Callback after a checkbox is unchecked. */ - onUnchecked?: (this: HTMLElement) => void; + onUnchecked?(this: HTMLElement): void; /** * Callback before a checkbox is checked. Can cancel change by returning false */ - beforeChecked?: (this: HTMLElement) => boolean; + beforeChecked?(this: HTMLElement): boolean; /** * Callback before a checkbox is set to undeterminate. Can cancel change by returning false */ - beforeIndeterminate?: (this: HTMLElement) => boolean; + beforeIndeterminate?(this: HTMLElement): boolean; /** * Callback before a checkbox is set to determinate. Can cancel change by returning false */ - beforeDeterminate?: (this: HTMLElement) => boolean; + beforeDeterminate?(this: HTMLElement): boolean; /** * Callback before a checkbox is unchecked. Can cancel change by returning false */ - beforeUnchecked?: (this: HTMLElement) => boolean; + beforeUnchecked?(this: HTMLElement): boolean; /** * Callback after a checkbox is enabled. */ - onEnable?: (this: HTMLElement) => void; + onEnable?(this: HTMLElement): void; /** * Callback after a checkbox is disabled. */ - onDisable?: (this: HTMLElement) => void; + onDisable?(this: HTMLElement): void; /** * Callback after a checkbox is enabled. * * @deprecated */ - onEnabled?: (this: HTMLElement) => void; + onEnabled?(this: HTMLElement): void; /** * Callback after a checkbox is disabled. * * @deprecated */ - onDisabled?: (this: HTMLElement) => void; + onDisabled?(this: HTMLElement): void; // endregion @@ -1676,15 +1699,15 @@ declare namespace SemanticUI { /** * Callback on element show */ - onShow?: (this: JQuery) => void; + onShow?(this: JQuery): void; /** * Callback on element hide */ - onHide?: (this: JQuery) => void; + onHide?(this: JQuery): void; /** * Callback on element show or hide */ - onchange?: (this: JQuery) => void; + onchange?(this: JQuery): void; // endregion @@ -1711,7 +1734,7 @@ declare namespace SemanticUI { * Templates used to generate dimmer content */ template?: { - dimmer?: () => JQuery; + dimmer?(): JQuery; }; /** * Class names used to attach style to state @@ -1892,6 +1915,13 @@ declare namespace SemanticUI { * @default true */ saveRemoteData?: boolean; + /** + * When set to true API will be expected to return the complete result set, which will then be filtered clientside to only display matching results. + * + * @default false + * @since 2.2.8 + */ + filterRemoteData?: boolean; // endregion @@ -2078,39 +2108,39 @@ declare namespace SemanticUI { /** * Is called after a dropdown value changes. Receives the name and value of selection and the active menu element */ - onChange?: (this: JQuery, value: any, text: string, $choice: JQuery) => void; + onChange?(this: JQuery, value: any, text: string, $choice: JQuery): void; /** * Is called after a dropdown selection is added using a multiple select dropdown, only receives the added value */ - onAdd?: (this: JQuery, addedValue: any, addedText: string, $addedChoice: JQuery) => void; + onAdd?(this: JQuery, addedValue: any, addedText: string, $addedChoice: JQuery): void; /** * Is called after a dropdown selection is removed using a multiple select dropdown, only receives the removed value */ - onRemove?: (this: JQuery, removedValue: any, removedText: string, $removedChoice: JQuery) => void; + onRemove?(this: JQuery, removedValue: any, removedText: string, $removedChoice: JQuery): void; /** * Allows you to modify a label before it is added. Expects the jQ DOM element for a label to be returned. */ - onLabelCreate?: (this: JQuery, value: any, text: string) => JQuery; + onLabelCreate?(this: JQuery, value: any, text: string): JQuery; /** * Called when a label is remove, return false; will prevent the label from being removed. */ - onLabelRemove?: (this: JQuery, value: any) => false | void; + onLabelRemove?(this: JQuery, value: any): false | void; /** * Is called after a label is selected by a user */ - onLabelSelect?: (this: JQuery, $selectedLabels: JQuery) => void; + onLabelSelect?(this: JQuery, $selectedLabels: JQuery): void; /** * Is called after a dropdown is searched with no matching values */ - onNoResults?: (this: JQuery, searchValue: any) => void; + onNoResults?(this: JQuery, searchValue: any): void; /** * Is called before a dropdown is shown. If false is returned, dropdown will not be shown. */ - onShow?: (this: JQuery) => false | void; + onShow?(this: JQuery): false | void; /** * Is called before a dropdown is hidden. If false is returned, dropdown will not be hidden. */ - onHide?: (this: JQuery) => false | void; + onHide?(this: JQuery): false | void; // endregion @@ -2406,19 +2436,19 @@ declare namespace SemanticUI { /** * Callback when iframe is generated */ - onCreate?: (this: JQuery, url: string) => void; + onCreate?(this: JQuery, url: string): void; /** * Whenever an iframe contents is shown */ - onDisplay?: (this: JQuery) => void; + onDisplay?(this: JQuery): void; /** * Callback immediately before Embed is removed from DOM */ - onPlaceholderDisplay?: (this: JQuery) => void; + onPlaceholderDisplay?(this: JQuery): void; /** * Callback when module parameters are determined. Allows you to adjust parameters at run time by returning a new parameters object. */ - onEmbed?: (this: JQuery, parameters: any) => any; + onEmbed?(this: JQuery, parameters: any): any; // endregion @@ -2483,11 +2513,11 @@ declare namespace SemanticUI { /** * returns html for iframe */ - iframe?: (url: string, parameters: string) => string; + iframe?(url: string, parameters: string): string; /** * returns html for placeholder element */ - placeholder?: (image: string, icon: string) => string; + placeholder?(image: string, icon: string): string; }; // endregion @@ -2599,27 +2629,27 @@ declare namespace SemanticUI { /** * Is called when a modal starts to show. */ - onShow?: (this: JQuery) => void; + onShow?(this: JQuery): void; /** * Is called after a modal has finished showing animating. */ - onVisible?: (this: JQuery) => void; + onVisible?(this: JQuery): void; /** * Is called after a modal starts to hide. If the function returns false, the modal will not hide. */ - onHide?: (this: JQuery, $element: JQuery) => false | void; + onHide?(this: JQuery, $element: JQuery): false | void; /** * Is called after a modal has finished hiding animation. */ - onHidden?: (this: JQuery) => void; + onHidden?(this: JQuery): void; /** * Is called after a positive, approve or ok button is pressed. If the function returns false, the modal will not hide. */ - onApprove?: (this: JQuery, $element: JQuery) => false | void; + onApprove?(this: JQuery, $element: JQuery): false | void; /** * Is called after a negative, deny or cancel button is pressed. If the function returns false the modal will not hide. */ - onDeny?: (this: JQuery, $element: JQuery) => false | void; + onDeny?(this: JQuery, $element: JQuery): false | void; // endregion @@ -2747,7 +2777,7 @@ declare namespace SemanticUI { // region Callbacks - onHide?: (this: JQuery) => void; + onHide?(this: JQuery): void; // endregion @@ -2969,31 +2999,31 @@ declare namespace SemanticUI { /** * Callback on popup element creation, with created popup */ - onCreate?: (this: JQuery, $module: JQuery) => void; + onCreate?(this: JQuery, $module: JQuery): void; /** * Callback immediately before Popup is removed from DOM */ - onRemove?: (this: JQuery, $module: JQuery) => void; + onRemove?(this: JQuery, $module: JQuery): void; /** * Callback before popup is shown. Returning false from this callback will cancel the popup from showing. */ - onShow?: (this: JQuery, $module: JQuery) => false | void; + onShow?(this: JQuery, $module: JQuery): false | void; /** * Callback after popup is shown */ - onVisible?: (this: JQuery, $module: JQuery) => void; + onVisible?(this: JQuery, $module: JQuery): void; /** * Callback before popup is hidden. Returning false from this callback will cancel the popup from hiding. */ - onHide?: (this: JQuery, $module: JQuery) => false | void; + onHide?(this: JQuery, $module: JQuery): false | void; /** * Callback after popup is hidden */ - onHidden?: (this: JQuery, $module: JQuery) => void; + onHidden?(this: JQuery, $module: JQuery): void; /** * Callback after popup cannot be placed on screen */ - onUnplaceable?: (this: JQuery, $module: JQuery) => void; + onUnplaceable?(this: JQuery, $module: JQuery): void; // endregion @@ -3014,7 +3044,7 @@ declare namespace SemanticUI { /** * HTML content to display instead of preformatted title and content */ - html?: string; + html?: string | JQuery; // endregion @@ -3184,23 +3214,23 @@ declare namespace SemanticUI { /** * Callback on percentage change */ - onChange?: (this: JQuery, percent: number, value: number, total: number) => void; + onChange?(this: JQuery, percent: number, value: number, total: number): void; /** * Callback on success state */ - onSuccess?: (this: JQuery, total: number) => void; + onSuccess?(this: JQuery, total: number): void; /** * Callback on active state */ - onActive?: (this: JQuery, value: number, total: number) => void; + onActive?(this: JQuery, value: number, total: number): void; /** * Callback on error state */ - onError?: (this: JQuery, value: number, total: number) => void; + onError?(this: JQuery, value: number, total: number): void; /** * Callback on warning state */ - onWarning?: (this: JQuery, value: number, total: number) => void; + onWarning?(this: JQuery, value: number, total: number): void; // endregion @@ -3360,7 +3390,7 @@ declare namespace SemanticUI { /** * Is called after user selects a new rating */ - onRate?: (this: JQuery, value: number) => void; + onRate?(this: JQuery, value: number): void; // endregion @@ -3575,37 +3605,37 @@ declare namespace SemanticUI { * The first parameter includes the filtered response results for that element. * The function should return false to prevent default action (closing search results and selecting value). */ - onSelect?: (this: JQuery, result: any, response: any) => false | void; + onSelect?(this: JQuery, result: any, response: any): false | void; /** * Callback after processing element template to add HTML to results. Function should return false to prevent default actions. */ - onResultsAdd?: (this: JQuery, html: string) => false | void; + onResultsAdd?(this: JQuery, html: string): false | void; /** * Callback on search query */ - onSearchQuery?: (this: JQuery, query: string) => void; + onSearchQuery?(this: JQuery, query: string): void; /** * Callback on server response */ - onResults?: (this: JQuery, response: any) => void; + onResults?(this: JQuery, response: any): void; /** * Callback when results are opened */ - onResultsOpen?: (this: JQuery) => void; + onResultsOpen?(this: JQuery): void; /** * Callback when results are closed */ - onResultsClose?: (this: JQuery) => void; + onResultsClose?(this: JQuery): void; // endregion // region Templates templates?: { - escape?: (string: string) => string; - message?: (message: string, type: string) => string; - category?: (response: any) => string; - standard?: (response: any) => string; + escape?(string: string): string; + message?(message: string, type: string): string; + category?(response: any): string; + standard?(response: any): string; }; // endregion @@ -3769,11 +3799,11 @@ declare namespace SemanticUI { /** * Is called before side change */ - beforeChange?: (this: JQuery) => void; + beforeChange?(this: JQuery): void; /** * Is called after visible side change */ - onChange?: (this: JQuery) => void; + onChange?(this: JQuery): void; // endregion @@ -3966,23 +3996,23 @@ declare namespace SemanticUI { /** * Is called when a sidebar begins animating in. */ - onVisible?: (this: JQuery) => void; + onVisible?(this: JQuery): void; /** * Is called when a sidebar has finished animating in. */ - onShow?: (this: JQuery) => void; + onShow?(this: JQuery): void; /** * Is called when a sidebar begins to hide or show */ - onChange?: (this: JQuery) => void; + onChange?(this: JQuery): void; /** * Is called before a sidebar begins to animate out. */ - onHide?: (this: JQuery) => void; + onHide?(this: JQuery): void; /** * Is called after a sidebar has finished animating out. */ - onHidden?: (this: JQuery) => void; + onHidden?(this: JQuery): void; // endregion @@ -4153,27 +4183,27 @@ declare namespace SemanticUI { /** * Callback when element is repositioned from layout change */ - onReposition?: (this: JQuery) => void; + onReposition?(this: JQuery): void; /** * Callback when requestAnimationFrame fires from scroll handler. */ - onScroll?: (this: JQuery) => void; + onScroll?(this: JQuery): void; /** * Callback when element is fixed to page */ - onStick?: (this: JQuery) => void; + onStick?(this: JQuery): void; /** * Callback when element is unfixed from page */ - onUnstick?: (this: JQuery) => void; + onUnstick?(this: JQuery): void; /** * Callback when element is bound to top of parent container */ - onTop?: (this: JQuery) => void; + onTop?(this: JQuery): void; /** * Callback when element is bound to bottom of parent container */ - onBottom?: (this: JQuery) => void; + onBottom?(this: JQuery): void; // endregion @@ -4338,6 +4368,13 @@ declare namespace SemanticUI { * @default 25 */ maxDepth?: number; + /** + * When enabled only calls remote endpoint for tab data on first load and leaves the DOM undisturbed afterwards. + * + * @default false + * @since 2.2.8 + */ + loadOnce?: boolean; // endregion @@ -4346,19 +4383,19 @@ declare namespace SemanticUI { /** * Callback only the first time a tab is loaded */ - onFirstLoad?: (this: JQuery, tabPath: string, parameterArray: any[], historyEvent: any) => void; + onFirstLoad?(this: JQuery, tabPath: string, parameterArray: any[], historyEvent: any): void; /** * Callback every time a tab is loaded */ - onLoad?: (this: JQuery, tabPath: string, parameterArray: any[], historyEvent: any) => void; + onLoad?(this: JQuery, tabPath: string, parameterArray: any[], historyEvent: any): void; /** * Called when a tab begins loading remote content */ - onRequest?: (this: JQuery, tabPath: string) => void; + onRequest?(this: JQuery, tabPath: string): void; /** * Called after a tab becomes visible */ - onVisible?: (this: JQuery, tabPath: string) => void; + onVisible?(this: JQuery, tabPath: string): void; // endregion @@ -4371,7 +4408,7 @@ declare namespace SemanticUI { /** * returns page title */ - determineTitle?: (tabArray: any[]) => string; + determineTitle?(tabArray: any[]): string; }; /** * Selectors used by module @@ -4515,19 +4552,19 @@ declare namespace SemanticUI { /** * Callback on each transition that changes visibility to shown */ - onShow?: (this: JQuery) => void; + onShow?(this: JQuery): void; /** * Callback on each transition that changes visibility to hidden */ - onHide?: (this: JQuery) => void; + onHide?(this: JQuery): void; /** * Callback on animation start, useful for queued animations */ - onStart?: (this: JQuery) => void; + onStart?(this: JQuery): void; /** * Callback on each transition complete */ - onComplete?: (this: JQuery) => void; + onComplete?(this: JQuery): void; // endregion @@ -4736,45 +4773,45 @@ declare namespace SemanticUI { /** * Allows modifying settings before request, or cancelling request */ - beforeSend?: (settings: ApiSettings) => any; + beforeSend?(settings: ApiSettings): any; /** * Allows modifying XHR object for request */ - beforeXHR?: (xhrObject: JQueryXHR) => any; + beforeXHR?(xhrObject: JQueryXHR): any; /** * Callback that occurs when request is made. Receives both the API success promise and the XHR request promise. */ - onRequest?: (promise: JQueryDeferred, xhr: JQueryXHR) => void; + onRequest?(promise: JQueryDeferred, xhr: JQueryXHR): void; /** * Allows modifying the server's response before parsed by other callbacks to determine API event success */ - onResponse?: (response: any) => void; + onResponse?(response: any): void; /** * Determines whether completed JSON response should be treated as successful * * @see {@link http://semantic-ui.com/behaviors/api.html#determining-json-success} */ - successTest?: (response: any) => boolean; + successTest?(response: any): boolean; /** * Callback after successful response, JSON response must pass successTest */ - onSuccess?: (response: any, element: JQuery, xhr: JQueryXHR) => void; + onSuccess?(response: any, element: JQuery, xhr: JQueryXHR): void; /** * Callback on request complete regardless of conditions */ - onComplete?: (response: any, element: JQuery, xhr: JQueryXHR) => void; + onComplete?(response: any, element: JQuery, xhr: JQueryXHR): void; /** * Callback on failed response, or JSON response that fails successTest */ - onFailure?: (response: any, element: JQuery) => void; + onFailure?(response: any, element: JQuery): void; /** * Callback on server error from returned status code, or XHR failure. */ - onError?: (errorMessage: string, element: JQuery, xhr: JQueryXHR) => void; + onError?(errorMessage: string, element: JQuery, xhr: JQueryXHR): void; /** * Callback on abort caused by user clicking a link or manually cancelling request. */ - onAbort?: (errorMessage: string, element: JQuery, xhr: JQueryXHR) => void; + onAbort?(errorMessage: string, element: JQuery, xhr: JQueryXHR): void; // endregion @@ -4948,6 +4985,9 @@ declare namespace SemanticUI { * @default 150 */ duration?: number; + fields?: { + [name: string]: string | string[] | Field; + }; // endregion @@ -4995,11 +5035,11 @@ declare namespace SemanticUI { /** * @default '{name} must be set to a number' */ - number?: string; + number?: string; /** * @default '{name} must be \'{ruleValue}\'' */ - is?: string; + is?: string; /** * @default '{name} must be exactly \'{ruleValue}\'' */ @@ -5077,19 +5117,36 @@ declare namespace SemanticUI { /** * Callback on each valid field */ - onValid?: (this: JQuery) => void; + onValid?(this: JQuery): void; /** * Callback on each invalid field */ - onInvalid?: (this: JQuery) => void; + onInvalid?(this: JQuery): void; /** * Callback if a form is all valid */ - onSuccess?: (this: JQuery, event: JQueryEventObject, fields: any) => void; + onSuccess?(this: JQuery, event: JQueryEventObject, fields: any): void; /** * Callback if any form field is invalid */ - onFailure?: (this: JQuery, formErrors: string[], fields: any) => void; + onFailure?(this: JQuery, formErrors: string[], fields: any): void; + + // endregion + + // region Templates + + templates?: { + error?: (errors: string[]) => JQuery; + prompt?: (errors: string[]) => JQuery; + }; + + // endregion + + // region Rules + + rules?: { + [name: string]: (...args: any[]) => boolean; + }; // endregion @@ -5169,6 +5226,16 @@ declare namespace SemanticUI { // endregion } + interface Field { + identifier: string; + rules: Rule[]; + } + + interface Rule { + type: string; + prompt: string; + } + // endregion // region Visibility @@ -5196,7 +5263,7 @@ declare namespace SemanticUI { * * @default false */ - type?: false | 'image' | 'fixed'; + type?: false | 'image' | 'fixed'; /** * Whether visibility conditions should be checked immediately on init * @@ -5279,43 +5346,45 @@ declare namespace SemanticUI { /** * Element's top edge has passed bottom of screen */ - onTopVisible?: (this: JQuery) => void; + onTopVisible?(this: JQuery): void; /** * Element's top edge has passed top of the screen */ - onTopPassed?: (this: JQuery) => void; + onTopPassed?(this: JQuery): void; /** * Element's bottom edge has passed bottom of screen */ - onBottomVisible?: (this: JQuery) => void; + onBottomVisible?(this: JQuery): void; /** * Any part of an element is visible on screen */ - onPassing?: (this: JQuery) => void; + onPassing?(this: JQuery): void; /** * Element's bottom edge has passed top of screen */ - onBottomPassed?: (this: JQuery) => void; + onBottomPassed?(this: JQuery): void; /** * Element's top edge has not passed bottom of screen */ - onTopVisibleReverse?: (this: JQuery) => void; + onTopVisibleReverse?(this: JQuery): void; /** * Element's top edge has not passed top of the screen */ - onTopPassedReverse?: (this: JQuery) => void; + onTopPassedReverse?(this: JQuery): void; /** * Element's bottom edge has not passed bottom of screen */ - onBottomVisibleReverse?: (this: JQuery) => void; + onBottomVisibleReverse?(this: JQuery): void; /** * Element's top has not passed top of screen but bottom has */ - onPassingReverse?: (this: JQuery) => void; + onPassingReverse?(this: JQuery): void; /** * Element's bottom edge has not passed top of screen */ onBottomPassedReverse?: (this: JQuery) => void; + onOnScreen?: (this: JQuery) => void; + onOffScreen?: (this: JQuery) => void; // endregion @@ -5326,13 +5395,13 @@ declare namespace SemanticUI { * * @since 2.2 */ - onLoad?: (this: JQuery) => void; + onLoad?(this: JQuery): void; /** * Occurs after all img initialized at the same time have loaded. * * @since 2.2 */ - onAllLoaded?: (this: JQuery) => void; + onAllLoaded?(this: JQuery): void; // endregion @@ -5343,13 +5412,13 @@ declare namespace SemanticUI { * * @since 2.2 */ - onFixed?: (this: JQuery) => void; + onFixed?(this: JQuery): void; /** * Occurs after element has been removed from fixed position * * @since 2.2 */ - onUnfixed?: (this: JQuery) => void; + onUnfixed?(this: JQuery): void; // endregion @@ -5358,11 +5427,11 @@ declare namespace SemanticUI { /** * Occurs each time an elements calculations are updated */ - onUpdate?: (this: JQuery, calculations: ElementCalculations) => void; + onUpdate?(this: JQuery, calculations: ElementCalculations): void; /** * Occurs whenever element's visibility is refreshed */ - onRefresh?: (this: JQuery) => void; + onRefresh?(this: JQuery): void; // endregion diff --git a/types/semantic-ui/semantic-ui-tests.ts b/types/semantic-ui/semantic-ui-tests.ts index f116507459..ad71c0fe92 100644 --- a/types/semantic-ui/semantic-ui-tests.ts +++ b/types/semantic-ui/semantic-ui-tests.ts @@ -1,4 +1,4 @@ -function test_Accordion() { +function test_accordion() { const selector = '.ui.accordion'; $(selector).accordion('refresh'); $(selector).accordion('open', 0); @@ -12,129 +12,220 @@ function test_Accordion() { }); $(selector).accordion(); } -test_Accordion(); -function test_Checkbox() { +function test_checkbox() { const selector = '.ui.checkbox'; $(selector).checkbox({}); $(selector).checkbox(); } -test_Checkbox(); -function test_Dimmer() { +function test_dimmer() { const selector = '.ui.dimmer'; $(selector).dimmer({}); $(selector).dimmer(); } -test_Dimmer(); -function test_Dropdown() { +function test_dropdown() { const selector = '.ui.dropdown'; $(selector).dropdown({}); $(selector).dropdown(); } -test_Dropdown(); -function test_Embed() { +function test_embed() { const selector = '.ui.embed'; $(selector).embed({}); $(selector).embed(); } -test_Embed(); -function test_Modal() { +function test_modal() { const selector = '.ui.modal'; $(selector).modal({}); $(selector).modal(); } -test_Modal(); -function test_Nag() { +function test_nag() { const selector = '.ui.nag'; $(selector).nag({}); } -test_Nag(); -function test_Popup() { +function test_popup() { const selector = '.ui.popup'; - $(selector).popup({}); + $(selector).popup({ + html: '
    Content
    ' + }); + $(selector).popup({ + html: $('
    Content
    ') + }); $(selector).popup(); } -test_Popup(); -function test_Progress() { +function test_progress() { const selector = '.ui.progress'; $(selector).progress({}); $(selector).progress(); } -test_Progress(); -function test_Rating() { +function test_rating() { const selector = '.ui.rating'; $(selector).rating({}); $(selector).rating(); } -test_Rating(); -function test_Search() { +function test_search() { const selector = '.ui.search'; $(selector).search({}); $(selector).search(); } -test_Search(); -function test_Shape() { +function test_shape() { const selector = '.ui.shape'; $(selector).shape({}); $(selector).shape(); } -test_Shape(); -function test_Sidebar() { +function test_sidebar() { const selector = '.ui.sidebar'; $(selector).sidebar({}); $(selector).sidebar(); } -test_Sidebar(); -function test_Sticky() { +function test_sticky() { const selector = '.ui.sticky'; $(selector).sticky({}); $(selector).sticky(); } -test_Sticky(); -function test_Tab() { +function test_tab() { const selector = '.ui.tab'; $(selector).tab({}); $(selector).tab(); } -test_Tab(); -function test_Transition() { +function test_transition() { const selector = '.ui.transition'; $(selector).transition({}); $(selector).transition(); } -test_Transition(); -function test_Api() { +function test_api() { const selector = '.ui.api'; $(selector).api({}); $(selector).api(); } -test_Api(); -function test_Form() { +function test_form() { const selector = '.ui.form'; $(selector).form({}); $(selector).form(); } -test_Form(); -function test_Visibility() { +function test_form_specifyingValidationRules() { + $('.ui.form').form({ + fields: { + name: 'empty', + gender: 'empty', + username: 'empty', + password: ['minLength[6]', 'empty'], + skills: ['minCount[2]', 'empty'], + terms: 'checked' + } + }); + + $('.ui.form').form({ + fields: { + name: { + identifier: 'name', + rules: [{ + type: 'empty', + prompt: 'Please enter your name' + }] + }, + skills: { + identifier: 'skills', + rules: [{ + type: 'minCount[2]', + prompt: 'Please select at least two skills' + }] + }, + gender: { + identifier: 'gender', + rules: [{ + type: 'empty', + prompt: 'Please select a gender' + }] + }, + username: { + identifier: 'username', + rules: [{ + type: 'empty', + prompt: 'Please enter a username' + }] + }, + password: { + identifier: 'password', + rules: [{ + type: 'empty', + prompt: 'Please enter a password' + }, { + type: 'minLength[6]', + prompt: 'Your password must be at least {ruleValue} characters' + }] + }, + terms: { + identifier: 'terms', + rules: [{ + type: 'checked', + prompt: 'You must agree to the terms and conditions' + }] + } + } + }); +} + +function test_form_addCustomRule() { + const user = { adminLevel: 1 }; + $.fn.form.settings.rules.adminLevel = (value: any, adminLevel: number) => { + return (user.adminLevel >= adminLevel); + }; + $('.ui.form').form({ + fields: { + dog: { + identifier: 'dog', + rules: [{ + type: 'adminLevel[2]', + prompt: 'You must be at least a level-2 admin to add a dog' + }] + } + } + }); +} + +function test_visibility() { const selector = '.ui.visibility'; $(selector).visibility({}); $(selector).visibility(); } -test_Visibility(); + +function test_settings() { + $.fn.accordion.settings.verbose = true; + $.fn.checkbox.settings.verbose = true; + $.fn.dimmer.settings.verbose = true; + $.fn.dropdown.settings.verbose = true; + $.fn.embed.settings.verbose = true; + $.fn.modal.settings.verbose = true; + $.fn.nag.settings.verbose = true; + $.fn.popup.settings.verbose = true; + $.fn.progress.settings.verbose = true; + $.fn.rating.settings.verbose = true; + $.fn.search.settings.verbose = true; + $.fn.shape.settings.verbose = true; + $.fn.sidebar.settings.verbose = true; + $.fn.sticky.settings.verbose = true; + $.fn.tab.settings.verbose = true; + $.fn.transition.settings.verbose = true; + + $.fn.api.settings.verbose = true; + $.fn.form.settings.verbose = true; + $.fn.visibility.settings.verbose = true; +} +test_settings(); diff --git a/types/semantic-ui/tslint.json b/types/semantic-ui/tslint.json index 68d10d72a6..ce6e8c6da1 100644 --- a/types/semantic-ui/tslint.json +++ b/types/semantic-ui/tslint.json @@ -1,6 +1,7 @@ { "extends": "../tslint.json", "rules": { - "unified-signatures": false + "unified-signatures": false, + "prefer-method-signature": false } } diff --git a/types/semver-diff/index.d.ts b/types/semver-diff/index.d.ts index 550784e697..e5a1369439 100644 --- a/types/semver-diff/index.d.ts +++ b/types/semver-diff/index.d.ts @@ -9,4 +9,4 @@ declare namespace SemverDiff { declare function SemverDiff(versionA: string, versionB: string): SemverDiff.SemverDiffReturn; -export = SemverDiff; \ No newline at end of file +export = SemverDiff; diff --git a/types/semver/semver-tests.ts b/types/semver/semver-tests.ts index f1be6ca533..b7a1299ad3 100644 --- a/types/semver/semver-tests.ts +++ b/types/semver/semver-tests.ts @@ -1,20 +1,21 @@ import * as semver from "semver"; -var obj: {}; -var bool: boolean; -var num: number; -var str: string; -var diff: string; -var x: any = null; -var arr: any[]; -var exp: RegExp; -var strArr: string[]; -var numArr: string[]; +let obj: {}; +let bool: boolean; +let num: number; +let str: string; +let diff: string; +let x: any = null; +let arr: any[]; +let exp: RegExp; +let strArr: string[]; +let numArr: string[]; -var v1: string, v2: string; -var version: string; -var versions: string[]; -var loose: boolean; +let v1: string; +let v2: string; +let version: string; +let versions: string[]; +let loose: boolean; str = semver.valid(str); str = semver.clean(str); @@ -48,7 +49,7 @@ bool = semver.gtr(version, str, loose); bool = semver.ltr(version, str, loose); bool = semver.outside(version, str, str, loose); -var ver = new semver.SemVer(str, bool); +let ver = new semver.SemVer(str, bool); str = ver.raw; bool = ver.loose; str = ver.format(); @@ -67,8 +68,7 @@ num = ver.compareMain(ver); num = ver.comparePre(ver); ver = ver.inc(str); - -var comp = new semver.Comparator(str, bool); +const comp = new semver.Comparator(str, bool); str = comp.toString(); ver = comp.semver; @@ -77,8 +77,7 @@ bool = comp.value; comp.parse(str); bool = comp.test(ver); - -var range = new semver.Range(str, bool); +const range = new semver.Range(str, bool); str = range.raw; bool = range.loose; str = range.format(); @@ -87,8 +86,8 @@ str = range.toString(); bool = range.test(ver); -var sets: semver.Comparator[][]; +let sets: semver.Comparator[][]; sets = range.set; -var lims: semver.Comparator[]; +let lims: semver.Comparator[]; lims = range.parseRange(str); diff --git a/types/serialize-javascript/index.d.ts b/types/serialize-javascript/index.d.ts index 9cfa69b977..deb4331961 100644 --- a/types/serialize-javascript/index.d.ts +++ b/types/serialize-javascript/index.d.ts @@ -10,9 +10,9 @@ declare namespace serializeJavascript { * It can be used to add whitespace and indentation to the serialized output to make it more readable. */ space?: string | number | undefined; - /** - * This option is a signal to serialize() that the object being serialized does not contain any function or regexps values. - * This enables a hot-path that allows serialization to be over 3x faster. + /** + * This option is a signal to serialize() that the object being serialized does not contain any function or regexps values. + * This enables a hot-path that allows serialization to be over 3x faster. * If you're serializing a lot of data, and know its pure JSON, then you can enable this option for a speed-up. */ isJSON?: boolean; diff --git a/types/sha1/sha1-tests.ts b/types/sha1/sha1-tests.ts index 22467632c8..6ce833b10b 100644 --- a/types/sha1/sha1-tests.ts +++ b/types/sha1/sha1-tests.ts @@ -1,29 +1,6 @@ import fs = require("fs"); import sha1 = require("sha1"); -/** - * API - * sha1(message) - * message -- String or Buffer - * returns String - * - * Usage - **************************************************** - * var sha1 = require('sha1'); * - * console.log(sha1('message')); * - **************************************************** - * This will print the following - * 6f9b9af3cd6e8b8a73c2cdced37fe9f59226e27d - * - * It supports buffers, too - **************************************************** - * var fs = require('fs'); * - * var sha1 = require('sha1'); * - * * - * fs.readFile('example.txt', function(err, buf) { * - * console.log(sha1(buf)); * - * }); * - * ************************************************** - */ + console.log(sha1('message')); // should print 6f9b9af3cd6e8b8a73c2cdced37fe9f59226e27d const testTwo = sha1('message', {asString: true}); diff --git a/types/sharepoint/index.d.ts b/types/sharepoint/index.d.ts index da19c221d4..dea4cae4fa 100644 --- a/types/sharepoint/index.d.ts +++ b/types/sharepoint/index.d.ts @@ -1549,7 +1549,7 @@ declare namespace SPAnimation { class State { SetAttribute(attributeId: Attribute, value: number): void; GetAttribute(attributeId: Attribute): number; - GetDataIndex(attributeId: Attribute): number + GetDataIndex(attributeId: Attribute): number; } class Object { @@ -5134,7 +5134,8 @@ declare namespace Microsoft.SharePoint.Client.Search { get_uiLanguage: () => number; set_uiLanguage: (value: number) => void; - getQuerySuggestionsWithResults: (iNumberOfQuerySuggestions: number, + getQuerySuggestionsWithResults: ( + iNumberOfQuerySuggestions: number, iNumberOfResultSuggestions: number, fPreQuerySuggestions: boolean, fHitHighlighting: boolean, @@ -5493,7 +5494,8 @@ declare namespace Microsoft.SharePoint.Client.Search { namespace Administration { class DocumentCrawlLog extends SP.ClientObject { constructor(context: SP.ClientContext, site: SP.Site); - getCrawledUrls: (getCountOnly: boolean, + getCrawledUrls: ( + getCountOnly: boolean, maxRows: { High: number; Low: number; }, queryString: string, isLike: boolean, @@ -9299,7 +9301,7 @@ declare class SPClientPeoplePicker { WebApplicationID: SP.Guid; // '{00000000-0000-0000-0000-000000000000}', GetAllUserInfo(): ISPClientPeoplePickerEntity[]; - SetInitialValue(entities: ISPClientPeoplePickerEntity[], initialErrorMsg?: string): void + SetInitialValue(entities: ISPClientPeoplePickerEntity[], initialErrorMsg?: string): void; AddUserKeys(userKeys: string, bSearch: boolean): void; BatchAddUserKeysOperation(allKeys: string[], numProcessed: number): void; ResolveAllUsers(fnContinuation: () => void): void; @@ -9331,7 +9333,7 @@ declare class SPClientPeoplePicker { IterateEachProcessedUser(fnCallback: (index: number, user: SPClientPeoplePickerProcessedUser) => void): void; HasResolvedUsers(): boolean; Validate(): void; - ValidateCurrentState(): void + ValidateCurrentState(): void; GetUnresolvedEntityErrorMessage(): string; ShowErrorMessage(msg: string): void; ClearServerError(): void; @@ -11652,7 +11654,7 @@ declare namespace Srch { /** Same as $addHandler with safety checks */ static addHandler(element: Element, eventName: string, handler: (instance: any, eventArgs: any) => void): void; /** Same as $removeHandler with safety checks */ - static removeHandler(element: Element, eventName: string, handler: (instance: any, eventArgs: any) => void): void + static removeHandler(element: Element, eventName: string, handler: (instance: any, eventArgs: any) => void): void; /** Returns true if the specified element is a descendant of the container element */ static isDescendant(element: Element, container: Element): boolean; @@ -11670,7 +11672,7 @@ declare namespace Srch { static findResultObjectFromDOM(e: Element, type: string): any; /** Appends specified parameter key and value string to the specified URL */ - static appendUrlParameter(url: string, keyAndValue: string): string + static appendUrlParameter(url: string, keyAndValue: string): string; /** Ensures that the given URL protocol value is allowed. Returns the specified URL value if the protocol is allowed; empty string otherwise. */ static ensureAllowedProtocol(value: string): string; diff --git a/types/sharepoint/sharepoint-tests.ts b/types/sharepoint/sharepoint-tests.ts index 34966f5a81..e6f885dcd4 100644 --- a/types/sharepoint/sharepoint-tests.ts +++ b/types/sharepoint/sharepoint-tests.ts @@ -1728,7 +1728,7 @@ namespace spdevlab { }); }); } - }; + } } } @@ -2156,7 +2156,7 @@ namespace _ { $('#report').children().remove(); $('#report').append("Failed to get session. Error: " + args.get_message()); } -}; +} // publishing.ts // Variables used in various callbacks @@ -2349,7 +2349,6 @@ namespace App { .then(l => this.lists = l) .catch((e: string) => this.$n.show(e, true)) .finally(() => this.$n.remove(loading)); - ; } } diff --git a/types/sharepoint/tslint.json b/types/sharepoint/tslint.json index e4f5db4fa0..e094a35492 100644 --- a/types/sharepoint/tslint.json +++ b/types/sharepoint/tslint.json @@ -1,6 +1,7 @@ { "extends": "../tslint.json", "rules": { + "jsdoc-format": false, "max-line-length": false } } diff --git a/types/sharp/sharp-tests.ts b/types/sharp/sharp-tests.ts index 2ca348620a..86d01066dc 100644 --- a/types/sharp/sharp-tests.ts +++ b/types/sharp/sharp-tests.ts @@ -47,7 +47,7 @@ sharp('input.jpg') // containing a scaled and cropped version of input.jpg }); -var transformer = sharp() +let transformer = sharp() .resize(300) .on('info', (info: sharp.OutputInfo) => { console.log('Image height is ' + info.height); diff --git a/types/sheetify/sheetify-tests.ts b/types/sheetify/sheetify-tests.ts index 31b35c220d..eba3a63336 100644 --- a/types/sheetify/sheetify-tests.ts +++ b/types/sheetify/sheetify-tests.ts @@ -1,8 +1,8 @@ import * as sheetify from 'sheetify'; -function done1(err: Error, css: string, prefix: string) {}; -function done2(err: Error, css: string) {}; -function done3(err: Error) {}; +function done1(err: Error, css: string, prefix: string) {} +function done2(err: Error, css: string) {} +function done3(err: Error) {} const test1 = sheetify('foobar'); const test2 = sheetify('foobar', {global: true}); diff --git a/types/shipit-utils/shipit-utils-tests.ts b/types/shipit-utils/shipit-utils-tests.ts index 81cb741054..36da5f0073 100644 --- a/types/shipit-utils/shipit-utils-tests.ts +++ b/types/shipit-utils/shipit-utils-tests.ts @@ -1,11 +1,9 @@ import shipit = require("shipit"); import utils = require("shipit-utils"); -var originalShipit = utils.getShipit(shipit); +const originalShipit = utils.getShipit(shipit); -var task = () => { - return shipit.local("sleep 10s"); -}; +const task = () => shipit.local("sleep 10s"); utils.registerTask(originalShipit, "myTask", task); utils.registerTask(originalShipit, "myTask", ["some", "other", "tasks"]); diff --git a/types/shipit/index.d.ts b/types/shipit/index.d.ts index 187b8c1f7d..3146b82fb0 100644 --- a/types/shipit/index.d.ts +++ b/types/shipit/index.d.ts @@ -32,7 +32,7 @@ interface Tasks { interface Task { blocking: boolean; dep: string[]; - fn: () => void; + fn(): void; name: string; } @@ -49,12 +49,12 @@ export function start(tasks: string | string[]): typeof shipit; export function start(...tasks: string[]): typeof shipit; export function task(name: string, depsOrFn: string[] | EmptyCallback, fn?: () => void): typeof shipit; -export var config: {}; -export var domain: any; -export var doneCallback: any; -export var environment: string; -export var seq: any[]; -export var tasks: Tasks; -export var isRunning: boolean; +export const config: {}; +export const domain: any; +export const doneCallback: any; +export const environment: string; +export const seq: any[]; +export const tasks: Tasks; +export const isRunning: boolean; export as namespace shipit; diff --git a/types/simple-oauth2/simple-oauth2-tests.ts b/types/simple-oauth2/simple-oauth2-tests.ts index 7a47078a71..83197a06eb 100644 --- a/types/simple-oauth2/simple-oauth2-tests.ts +++ b/types/simple-oauth2/simple-oauth2-tests.ts @@ -17,10 +17,8 @@ const credentials = { import oauth2lib = require("simple-oauth2"); const oauth2 = oauth2lib.create(credentials); - // #Authorization Code flow (() => { - // Authorization oauth2 URI const authorizationUri = oauth2.authorizationCode.authorizeURL({ redirect_uri: 'http://localhost:3000/callback', @@ -58,7 +56,6 @@ const oauth2 = oauth2lib.create(credentials); }); })(); - // #Client Credentials Flow (() => { const tokenConfig = {}; @@ -73,7 +70,6 @@ const oauth2 = oauth2lib.create(credentials); const token = oauth2.accessToken.create(result); }); - // Promises // Get the access token object for the client oauth2.clientCredentials @@ -86,7 +82,6 @@ const oauth2 = oauth2lib.create(credentials); }); })(); - // #Access Token object (() => { // Sample of a JSON access token (you got it through previous steps) @@ -97,7 +92,7 @@ const oauth2 = oauth2lib.create(credentials); }; // Create the access token wrapper - var token = oauth2.accessToken.create(tokenObject); + let token = oauth2.accessToken.create(tokenObject); // Check if the token is expired. If expired it is refreshed. if (token.expired()) { @@ -139,7 +134,6 @@ const oauth2 = oauth2lib.create(credentials); }); })(); - // #Errors // not applicable, as those errors about missing authentication codes are already found by the typescript compiler diff --git a/types/sinon/index.d.ts b/types/sinon/index.d.ts index 0dd6d29fce..224ab4003f 100644 --- a/types/sinon/index.d.ts +++ b/types/sinon/index.d.ts @@ -404,6 +404,9 @@ declare namespace Sinon { useFakeXMLHttpRequest: SinonFakeXMLHttpRequestStatic; useFakeServer(): SinonFakeServer; restore(): void; + reset(): void; + resetHistory(): void; + resetBehavior(): void; } interface SinonSandboxStatic { diff --git a/types/sinon/sinon-tests.ts b/types/sinon/sinon-tests.ts index afd20c2e18..8354045a25 100644 --- a/types/sinon/sinon-tests.ts +++ b/types/sinon/sinon-tests.ts @@ -98,6 +98,9 @@ function testSandbox() { sandbox.useFakeXMLHttpRequest(); sandbox.useFakeServer(); sandbox.restore(); + sandbox.reset(); + sandbox.resetHistory(); + sandbox.resetBehavior(); } function testPromises() { diff --git a/types/slimerjs/index.d.ts b/types/slimerjs/index.d.ts index 7fc8c2dfa7..784f814f57 100644 --- a/types/slimerjs/index.d.ts +++ b/types/slimerjs/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Alex Wall // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - declare var phantom: Phantom; declare var slimer: Slimer; @@ -19,7 +18,6 @@ interface Slimer { } interface Phantom { - // Properties args: string[]; // DEPRECATED cookies: Cookie[]; @@ -40,7 +38,7 @@ interface Phantom { injectJs(filename: string): boolean; // Callbacks - onError: (msg: string, trace: string[]) => any; + onError(msg: string, trace: string[]): any; } interface Std { @@ -69,11 +67,10 @@ interface SystemModule { interface HttpConf { operation: string; data: any; - headers: any + headers: any; } interface WebPage { - // Properties canGoBack: boolean; canGoForward: boolean; @@ -106,7 +103,7 @@ interface WebPage { viewportSize: Size; windowName: string; zoomFactor: number; - captureContent: Array; // slimerjs only + captureContent: RegExp[]; // slimerjs only // Functions addCookie(cookie: Cookie): boolean; @@ -142,9 +139,9 @@ interface WebPage { release(): void; // DEPRECATED reload(): void; // render(filename: string): Promise; + render(filename: string): void; render(filename: string, options?: { format?: string; quality?: string; ratio?: number; onlyViewport?: boolean }): Promise; renderBase64(type: string): Promise; - render(filename: string): void; renderBase64(format: string): string; sendEvent(mouseEventType: string, mouseX?: number, mouseY?: number, button?: string): Promise; sendEvent(keyboardEventType: string, key: string, null1?: null, null2?: null, modifier?: number): Promise; @@ -163,23 +160,23 @@ interface WebPage { uploadFile(selector: string, filename: string): void; // Callbacks - onAlert: (msg: string) => any; - onCallback: () => void; // EXPERIMENTAL - onClosing: (closingPage: WebPage) => any; - onConfirm: (msg: string) => boolean; - onConsoleMessage: (msg: string, lineNum?: number, sourceId?: string) => any; - onError: (msg: string, trace: string[]) => any; - onFilePicker: (oldFile: string) => string; - onInitialized: () => any; - onLoadFinished: (status: string) => any; - onLoadStarted: () => any; - onNavigationRequested: (url: string, type: string, willNavigate: boolean, main: boolean) => any; - onPageCreated: (newPage: WebPage) => any; - onPrompt: (msg: string, defaultVal: string) => string; - onResourceError: (resourceError: ResourceError) => any; - onResourceReceived: (response: ResourceResponse) => any; - onResourceRequested: (requestData: ResourceRequest, networkRequest: NetworkRequest) => any; - onUrlChanged: (targetUrl: string) => any; + onAlert(msg: string): any; + onCallback(): void; // EXPERIMENTAL + onClosing(closingPage: WebPage): any; + onConfirm(msg: string): boolean; + onConsoleMessage(msg: string, lineNum?: number, sourceId?: string): any; + onError(msg: string, trace: string[]): any; + onFilePicker(oldFile: string): string; + onInitialized(): any; + onLoadFinished(status: string): any; + onLoadStarted(): any; + onNavigationRequested(url: string, type: string, willNavigate: boolean, main: boolean): any; + onPageCreated(newPage: WebPage): any; + onPrompt(msg: string, defaultVal: string): string; + onResourceError(resourceError: ResourceError): any; + onResourceReceived(response: ResourceResponse): any; + onResourceRequested(requestData: ResourceRequest, networkRequest: NetworkRequest): any; + onUrlChanged(targetUrl: string): any; // Callback triggers closing(closingPage: WebPage): void; @@ -203,8 +200,8 @@ interface ResourceError { } interface HttpVersion { - major: number, - minor: number + major: number; + minor: number; } interface ResourceResponse { @@ -261,7 +258,6 @@ interface WebPageSettings { } interface FileSystem { - // Properties separator: string; workingDirectory: string; @@ -316,12 +312,11 @@ interface Stream { interface WebServerModule { registerDirectory(urlpath: string, directoryPath: string): void; registerFile(urlpath: string, filePath: string): void; - registerPathHandler(urlpath: string, handlerCallback: (request: WebServerRequest, response: WebServerResponse) => void): void + registerPathHandler(urlpath: string, handlerCallback: (request: WebServerRequest, response: WebServerResponse) => void): void; port: number; listen(port: number | string, cb?: (request: WebServerRequest, response: WebServerResponse) => void): boolean; // listen(ipAddressPort: string, cb?: (request: IWebServerRequest, response: IWebServerResponse) => void): boolean; close(): void; - } interface WebServerRequest { @@ -359,14 +354,14 @@ interface ClipRect extends TopLeft, Size { } interface Cookie { - name: string, - value: string, - domain?: string, - path: string, - httponly?: boolean, - secure?: boolean, - expires?: string, - expiry: number + name: string; + value: string; + domain?: string; + path: string; + httponly?: boolean; + secure?: boolean; + expires?: string; + expiry: number; } interface WebPageModule { diff --git a/types/slimerjs/slimerjs-tests.ts b/types/slimerjs/slimerjs-tests.ts index 604bd4f6f6..da40531769 100644 --- a/types/slimerjs/slimerjs-tests.ts +++ b/types/slimerjs/slimerjs-tests.ts @@ -1,21 +1,17 @@ -var webpageMod = require('webpage'); -var webserverMod = require('webserver') +const webpageMod = require('webpage'); // tslint:disable-line no-var-requires +const webserverMod = require('webserver'); // tslint:disable-line no-var-requires let page = webpageMod.create(); let vUrl = 'https://www.w3c.org'; - -function testWebserver () { - - webserverMod.close() +function testWebserver() { + webserverMod.close(); webserverMod.listen(1234); webserverMod.registerFile("urlPath", "filePath"); webserverMod.registerDirectory("urlPath", "dirPath"); - } - -let vUserAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 (KHTML, like Gecko) Version/10.0.3 Safari/602.4.8' +let vUserAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 (KHTML, like Gecko) Version/10.0.3 Safari/602.4.8'; page.settings.userAgent = vUserAgent; page.onConsoleMessage = (vMsg) => { @@ -27,7 +23,7 @@ page.onAlert = (vMsg) => { page.onLoadStarted = () => { }; -page.captureContent = [ /json/ ] +page.captureContent = [/json/]; page.onResourceReceived = (oResponse) => { oResponse.id; @@ -45,7 +41,6 @@ page.onResourceRequested = (oRequestData, oNetworkRequest) => { oRequestData.url; }; - page.onLoadFinished = (vStatus) => { phantom.exit(); }; @@ -54,18 +49,16 @@ page.onInitialized = () => { }; page.onPageCreated = (oPage) => { - let oCookie: Cookie + let oCookie: Cookie; oPage.addCookie(oCookie); }; - page.open(vUrl) // loads a page .then(() => { // executed after loading page.viewportSize = { width: 414, height: 736 }; - let vFilename = `../data/page01.png`; - page.render(vFilename, {onlyViewport: true}) + page.render(vFilename, {onlyViewport: true}); // then open a second page return page.open('http://'); @@ -73,5 +66,5 @@ page.open(vUrl) // loads a page .then(() => { // click somewhere on the second page page.sendEvent("click", 5, 5, 'left', 0); - slimer.exit() + slimer.exit(); }); diff --git a/types/slug/slug-tests.ts b/types/slug/slug-tests.ts index 5ba9aa7f29..cc6b4d1a10 100644 --- a/types/slug/slug-tests.ts +++ b/types/slug/slug-tests.ts @@ -1,5 +1,5 @@ import slug = require('slug'); -var print = console.log.bind(console, '>'); +const print = console.log.bind(console, '>'); print(slug('i ♥ unicode')); // > i-love-unicode @@ -38,4 +38,4 @@ slug.defaults.modes['pretty'] = { lower: false, charmap: slug.charmap, multicharmap: slug.multicharmap -}; \ No newline at end of file +}; diff --git a/types/sparkpost/index.d.ts b/types/sparkpost/index.d.ts index fc6e408949..24ac0efbcc 100644 --- a/types/sparkpost/index.d.ts +++ b/types/sparkpost/index.d.ts @@ -490,9 +490,11 @@ declare class SparkPost { * @param options The create options. If true, directly overwrite the existing published template. If false, create a new draft * @param callback The request callback with template id results */ - update(id: string, template: SparkPost.UpdateTemplate, options: { - update_published?: boolean; - }, callback: SparkPost.ResultsCallback<{ id: string }>): void; + update( + id: string, + template: SparkPost.UpdateTemplate, + options: { update_published?: boolean }, + callback: SparkPost.ResultsCallback<{ id: string }>): void; /** * Update an existing template * @@ -500,7 +502,9 @@ declare class SparkPost { * @param {SparkPost.UpdateTemplate} template an object of [template attributes]{@link https://developers.sparkpost.com/api/templates#header-template-attributes} * @param {SparkPost.ResultsCallback<{ id: string }>} callback The request callback with template id results */ - update(id: string, template: SparkPost.UpdateTemplate, + update( + id: string, + template: SparkPost.UpdateTemplate, callback: SparkPost.ResultsCallback<{ id: string }>): void; /** * Update an existing template @@ -759,12 +763,12 @@ declare class SparkPost { * @param options An optional limit that specifies the maximum number of results to return. Defaults to 1000 * @param callback The request callback with status results */ - getBatchStatus(id: string, options: { limit?: number }, callback: SparkPost.ResultsCallback<{ + getBatchStatus(id: string, options: { limit?: number }, callback: SparkPost.ResultsCallback): void; + }>>): void; /** * Gets recent status information about a webhook. * @@ -776,12 +780,12 @@ declare class SparkPost { * response_code: number; * }[]>} callback The request callback with status results */ - getBatchStatus(id: string, callback: SparkPost.ResultsCallback<{ + getBatchStatus(id: string, callback: SparkPost.ResultsCallback): void; + }>>): void; /** * Gets recent status information about a webhook. * @@ -794,12 +798,12 @@ declare class SparkPost { * response_code: number; * }[]>} The status results */ - getBatchStatus(id: string, options: { limit?: number }): SparkPost.ResultsPromise<{ + getBatchStatus(id: string, options: { limit?: number }): SparkPost.ResultsPromise; + }>>; /** * Lists descriptions of the events, event types, and event fields that could be included in a Webhooks post to your target URL. * @param callback The request callback containing documentation results @@ -852,44 +856,41 @@ declare class SparkPost { } declare namespace SparkPost { - - export interface ErrorWithDescription { + interface ErrorWithDescription { message: string; code: string; description: string; } - export interface ErrorWithParam { + interface ErrorWithParam { message: string; param: string; value: string | null; } - export interface SparkPostError extends Error { + interface SparkPostError extends Error { name: "SparkPostError"; errors: ErrorWithDescription[] | ErrorWithParam[]; statusCode: number; } - export interface ConstructorOptions { + interface ConstructorOptions { origin?: string; endpoint?: string; apiVersion?: string; headers?: any; } - export interface Response extends Http.IncomingMessage { + interface Response extends Http.IncomingMessage { body: T; } - export interface Callback { - (err: Error | SparkPostError | null, res: Response): void; - } - export type ResultsCallback = Callback<{ results: T }>; - export type ResultsPromise = Promise<{ results: T }>; + type Callback = (err: Error | SparkPostError | null, res: Response) => void; + type ResultsCallback = Callback<{ results: T }>; + type ResultsPromise = Promise<{ results: T }>; - export interface Domain { + interface Domain { domain: string; } - export interface MessageEvent { + interface MessageEvent { /** Type of event this record describes */ type: string; /** Classification code for a given message (see [Bounce Classification Codes](https://support.sparkpost.com/customer/portal/articles/1929896)) */ @@ -940,7 +941,7 @@ declare namespace SparkPost { transmission_id: string; } - export interface MessageEventParameters { + interface MessageEventParameters { /** delimited list of bounce classification codes to search. (See Bounce Classification Codes.) */ bounce_classes?: Array | string | number; /** delimited list of campaign ID’s to search (i.e. the campaign id used during creation of a transmission). */ @@ -975,14 +976,14 @@ declare namespace SparkPost { transmission_ids?: string[] | string; } - export interface RecipientListMetadata { + interface RecipientListMetadata { total_rejected_recipients: number; total_accepted_recipients: number; id: string; name: string; } - export interface RecipientList { + interface RecipientList { /** Short, unique, recipient list identifier */ id: string; /** Short, pretty/readable recipient list display name, not required to be unique */ @@ -994,12 +995,12 @@ declare namespace SparkPost { /** Number of accepted recipients */ total_accepted_recipients: number; } - export interface RecipientListWithRecipients extends RecipientList { + interface RecipientListWithRecipients extends RecipientList { /** Array of recipient objects */ recipients: Recipient[]; } - export interface CreateRecipientList { + interface CreateRecipientList { /** Short, unique, recipient list identifier */ id?: string; /** Short, pretty/readable recipient list display name, not required to be unique */ @@ -1013,7 +1014,7 @@ declare namespace SparkPost { /** Array of recipient objects */ recipients: Recipient[]; } - export interface UpdateRecipientList { + interface UpdateRecipientList { /** Short, unique, recipient list identifier */ id?: string; /** Short, pretty/readable recipient list display name, not required to be unique */ @@ -1026,7 +1027,7 @@ declare namespace SparkPost { recipients: Recipient[]; } - export interface BaseRecipient { + interface BaseRecipient { /** SparkPost Enterprise API only. Email to use for envelope FROM. */ return_path?: string; /** Array of text labels associated with a recipient. */ @@ -1036,11 +1037,11 @@ declare namespace SparkPost { /** Key/value pairs associated with a recipient that are provided to the substitution engine. */ substitution_data?: any; } - export interface RecipientWithAddress { + interface RecipientWithAddress { /** Address information for a recipient At a minimum, address or multichannel_addresses is required. */ address: Address | string; } - export interface RecipientWithMultichannelAddresses { + interface RecipientWithMultichannelAddresses { /** * Address information for a recipient. At a minimum, address or multichannel_addresses is required. * If both address and multichannel_addresses are specified only multichannel_addresses will be used. @@ -1058,9 +1059,9 @@ declare namespace SparkPost { */ multichannel_addresses: MultichannelAddress[]; } - export type Recipient = (RecipientWithAddress | RecipientWithMultichannelAddresses) & BaseRecipient; + type Recipient = (RecipientWithAddress | RecipientWithMultichannelAddresses) & BaseRecipient; - export interface Address { + interface Address { /** Valid email address */ email: string; /** User-friendly name for the email address */ @@ -1069,7 +1070,7 @@ declare namespace SparkPost { header_to?: string; } - export interface MultichannelAddress { + interface MultichannelAddress { /** The communication channel used to reach recipient. Valid values are “email”, “gcm”, “apns”. */ channel: string; /** Valid email address. Required if channel is “email”. */ @@ -1084,7 +1085,7 @@ declare namespace SparkPost { app_id: string; } - export interface RelayWebhook { + interface RelayWebhook { /** User-friendly name no example: Inbound Customer Replies */ name?: string; /** URL of the target to which to POST relay batches */ @@ -1095,7 +1096,7 @@ declare namespace SparkPost { match: Match; } - export interface UpdateRelayWebhook { + interface UpdateRelayWebhook { /** User-friendly name no example: Inbound Customer Replies */ name?: string; /** URL of the target to which to POST relay batches */ @@ -1106,7 +1107,7 @@ declare namespace SparkPost { match?: Match; } - export interface Match { + interface Match { /** Inbound messaging protocol associated with this webhook. Defaults to “SMTP” */ protocol?: string; /** Inbound domain associated with this webhook. Required when protocol is “SMTP”. */ @@ -1115,7 +1116,7 @@ declare namespace SparkPost { esme_address?: string; } - export interface SendingDomain { + interface SendingDomain { /** Name of the sending domain. */ domain: string; /** Associated tracking domain. */ @@ -1132,7 +1133,7 @@ declare namespace SparkPost { shared_with_subaccounts: boolean; } - export interface CreateSendingDomain { + interface CreateSendingDomain { /** Name of the sending domain. */ domain: string; /** Associated tracking domain. */ @@ -1149,7 +1150,7 @@ declare namespace SparkPost { shared_with_subaccounts?: boolean; } - export interface UpdateSendingDomain { + interface UpdateSendingDomain { /** Associated tracking domain. */ tracking_domain?: string; /** JSON object in which DKIM key configuration is defined. */ @@ -1162,7 +1163,7 @@ declare namespace SparkPost { shared_with_subaccounts?: boolean; } - export interface DKIM { + interface DKIM { /** Signing Domain Identifier (SDID). SparkPost Enterprise API only. */ signing_domain?: string; /** DKIM private key. */ @@ -1175,7 +1176,7 @@ declare namespace SparkPost { headers?: string; } - export interface Status { + interface Status { /** Whether domain ownership has been verified */ ownership_verified: boolean; /** Verification status of SPF configuration */ @@ -1190,7 +1191,7 @@ declare namespace SparkPost { postmaster_at_status: "valid" | "invalid" | "unverified" | "pending"; } - export interface VerifyOptions { + interface VerifyOptions { /** * Request verification of DKIM record * @@ -1236,14 +1237,14 @@ declare namespace SparkPost { abuse_at_token?: string; } - export interface VerifyResults extends Status { + interface VerifyResults extends Status { dns?: { dkim_record: string; spf_record: string; }; } - export interface CreateSubaccount { + interface CreateSubaccount { /** user-friendly name */ name: string; /** user-friendly identifier for subaccount API key */ @@ -1256,14 +1257,14 @@ declare namespace SparkPost { ip_pool?: string; } - export interface CreateSubaccountResponse { + interface CreateSubaccountResponse { subaccount_id: number; key: string; label: string; short_key: string; } - export interface UpdateSubaccount { + interface UpdateSubaccount { /** user-friendly name */ name: string; /** status of the subaccount */ @@ -1272,7 +1273,7 @@ declare namespace SparkPost { ip_pool?: string; } - export interface SubaccountInformation { + interface SubaccountInformation { /** ID of subaccount */ id: number; /** User friendly identifier for a specific subaccount */ @@ -1284,7 +1285,7 @@ declare namespace SparkPost { compliance_status: string; } - export interface CreateSupressionListEntry { + interface CreateSupressionListEntry { /** * Email address to be suppressed * @@ -1329,7 +1330,7 @@ declare namespace SparkPost { description?: string; } - export interface SupressionListEntry { + interface SupressionListEntry { /** * Email address to be suppressed * @@ -1372,7 +1373,7 @@ declare namespace SparkPost { updated: string; } - export interface SupressionSearchParameters { + interface SupressionSearchParameters { /** Datetime the entries were last updated, in the format of YYYY-MM-DDTHH:mm:ssZ */ to?: string; /** Datetime the entries were last updated, in the format YYYY-MM-DDTHH:mm:ssZ */ @@ -1431,7 +1432,7 @@ declare namespace SparkPost { limit?: number; } - export interface TemplateContent { + interface TemplateContent { /** HTML content for the email’s text/html MIME part */ html: string; /** Text content for the email’s text/plain MIME part */ @@ -1452,7 +1453,7 @@ declare namespace SparkPost { headers?: any; } - export interface CreateTemplateContent { + interface CreateTemplateContent { /** HTML content for the email’s text/html MIME part */ html?: string; /** Text content for the email’s text/plain MIME part */ @@ -1473,7 +1474,7 @@ declare namespace SparkPost { headers?: any; } - export interface TemplateMeta { + interface TemplateMeta { /** Unique template ID */ id: string; /** Template name */ @@ -1484,7 +1485,7 @@ declare namespace SparkPost { description: string; } - export interface Template { + interface Template { /** * Short, unique, alphanumeric ID used to reference the template. * At a minimum, id or name is required upon creation. @@ -1511,7 +1512,7 @@ declare namespace SparkPost { last_use?: string; } - export interface CreateTemplate { + interface CreateTemplate { /** * Short, unique, alphanumeric ID used to reference the template. * At a minimum, id or name is required upon creation. @@ -1534,7 +1535,7 @@ declare namespace SparkPost { options?: CreateTemplateOptions; } - export interface UpdateTemplate { + interface UpdateTemplate { /** Content that will be used to construct a message yes For a full description, see the Content Attributes. Maximum length - 20 MBs */ content?: CreateTemplateContent | { email_rfc822: string }; /** Whether the template is published or is a draft version no - defaults to false A template cannot be changed from published to draft. */ @@ -1547,7 +1548,7 @@ declare namespace SparkPost { options?: CreateTemplateOptions; } - export interface TemplateOptions { + interface TemplateOptions { /** Enable or disable open tracking */ open_tracking: boolean; /** Enable or disable click tracking */ @@ -1556,7 +1557,7 @@ declare namespace SparkPost { transactional: boolean; } - export interface CreateTemplateOptions { + interface CreateTemplateOptions { /** Enable or disable open tracking */ open_tracking?: boolean; /** Enable or disable click tracking */ @@ -1565,7 +1566,7 @@ declare namespace SparkPost { transactional?: boolean; } - export interface CreateTransmission { + interface CreateTransmission { /** JSON object in which transmission options are defined */ options?: TransmissionOptions; /** @@ -1598,7 +1599,7 @@ declare namespace SparkPost { content: InlineContent | { template_id: string, use_draft_template?: boolean } | { email_rfc822: string }; } - export interface TransmissionSummary { + interface TransmissionSummary { /** ID of the transmission */ id: string; /** State of the transmission */ @@ -1611,7 +1612,7 @@ declare namespace SparkPost { content: { template_id: string }; } - export interface Transmission { + interface Transmission { /** ID of the transmission */ id: string; /** State of the transmission */ @@ -1638,7 +1639,7 @@ declare namespace SparkPost { rcpt_list_total_chunks: number; } - export interface TransmissionOptions { + interface TransmissionOptions { /** Delay generation of messages until this datetime. */ start_time?: string; /** Whether open tracking is enabled for this transmission */ @@ -1657,7 +1658,7 @@ declare namespace SparkPost { inline_css?: boolean; } - export interface InlineContent { + interface InlineContent { /** HTML content for the email’s text/html MIME part At a minimum, html, text, or push is required. */ html?: string; /** Text content for the email’s text/plain MIME part At a minimum, html, text, or push is required. */ @@ -1678,14 +1679,14 @@ declare namespace SparkPost { inline_images?: Attachment[]; } - export interface PushData { + interface PushData { /** payload for APNs messages */ apns?: any; /** payload for GCM messages */ gcm?: any; } - export interface Attachment { + interface Attachment { /** * The MIME type of the attachment; e.g., “text/plain”, “image/jpeg”, “audio/mp3”, “video/mp4”, “application/msword”, “application/pdf”, etc., * including the “charset” parameter (text/html; charset=“UTF-8”) if needed. @@ -1708,7 +1709,7 @@ declare namespace SparkPost { data: string; } - export interface Webhook { + interface Webhook { /** User-friendly name for webhook */ name: string; /** URL of the target to which to POST event batches */ @@ -1733,7 +1734,7 @@ declare namespace SparkPost { auth_token?: string; } - export interface UpdateWebhook { + interface UpdateWebhook { /** User-friendly name for webhook */ name?: string; /** URL of the target to which to POST event batches */ @@ -1751,15 +1752,15 @@ declare namespace SparkPost { auth_token?: string; } - export interface WebhookLinks { - links: { + interface WebhookLinks { + links: Array<{ href: string; rel: string; method: string[]; - }[]; + }>; } - export interface CreateOpts { + interface CreateOpts { /** * Domain (or subdomain) name for which SparkPost will receive inbound emails * diff --git a/types/sparkpost/sparkpost-tests.ts b/types/sparkpost/sparkpost-tests.ts index d3fef264f0..409fbeac43 100644 --- a/types/sparkpost/sparkpost-tests.ts +++ b/types/sparkpost/sparkpost-tests.ts @@ -6,7 +6,7 @@ let client = new SparkPost(key); // Callback client.get({ uri: "metrics/domains" -}, function(err, data) { +}, (err, data) => { if (err) { console.log(err); return; @@ -27,7 +27,7 @@ client.get({ }); // Callback -client.inboundDomains.create({ domain: 'example1.com' }, function(err, res) { +client.inboundDomains.create({ domain: 'example1.com' }, (err, res) => { if (err) { console.log(err); } else { @@ -48,7 +48,7 @@ client.inboundDomains.create({ domain: 'example1.com' }) }); // Callback -client.inboundDomains.delete("example1.com", function(err, res) { +client.inboundDomains.delete("example1.com", (err, res) => { if (err) { console.log(err); } else { @@ -69,7 +69,7 @@ client.inboundDomains.delete('example1.com') }); // Callback -client.inboundDomains.get("example1.com", function(err, res) { +client.inboundDomains.get("example1.com", (err, res) => { if (err) { console.log(err); } else { @@ -90,7 +90,7 @@ client.inboundDomains.get('example1.com') }); // Callback -client.inboundDomains.list(function(err, res) { +client.inboundDomains.list((err, res) => { if (err) { console.log(err); } else { @@ -111,7 +111,7 @@ client.inboundDomains.list() }); // Callback -client.messageEvents.search({}, function(err, res) { +client.messageEvents.search({}, (err, res) => { if (err) { console.log(err); } else { @@ -124,7 +124,7 @@ client.messageEvents.search({}, function(err, res) { client.messageEvents.search({ events: "click", campaign_ids: "monday_mailshot" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -141,7 +141,7 @@ client.messageEvents.search({ per_page: 5, events: ["bounce", "out_of_band"], bounce_classes: [10] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -212,7 +212,7 @@ client.recipientLists.create({ } } ] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -251,7 +251,7 @@ client.recipientLists.create({ }); // Callback -client.recipientLists.delete("UNIQUE_TEST_ID", function(err, res) { +client.recipientLists.delete("UNIQUE_TEST_ID", (err, res) => { if (err) { console.log(err); } else { @@ -272,7 +272,7 @@ client.recipientLists.delete('UNIQUE_TEST_ID') }); // Callback -client.recipientLists.list(function(err, res) { +client.recipientLists.list((err, res) => { if (err) { console.log(err); } else { @@ -293,7 +293,7 @@ client.recipientLists.list() }); // Callback -client.recipientLists.get('UNIQUE_TEST_ID', function(err, res) { +client.recipientLists.get('UNIQUE_TEST_ID', (err, res) => { if (err) { console.log(err); } else { @@ -305,7 +305,7 @@ client.recipientLists.get('UNIQUE_TEST_ID', function(err, res) { // Callback client.recipientLists.get('UNIQUE_TEST_ID', { show_recipients: true -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -356,7 +356,7 @@ client.recipientLists.update('EXISTING_TEST_ID', { } } ] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -399,7 +399,7 @@ client.relayWebhooks.create({ match: { domain: "inbound.example.com" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -426,7 +426,7 @@ client.relayWebhooks.create({ }); // Callback -client.relayWebhooks.delete("123456789", function(err, res) { +client.relayWebhooks.delete("123456789", (err, res) => { if (err) { console.log(err); } else { @@ -447,7 +447,7 @@ client.relayWebhooks.delete('123456789') }); // Callback -client.relayWebhooks.get('123456789', function(err, res) { +client.relayWebhooks.get('123456789', (err, res) => { if (err) { console.log(err); } else { @@ -467,7 +467,7 @@ client.relayWebhooks.get('123456789') console.log(err); }); -client.relayWebhooks.list(function(err, res) { +client.relayWebhooks.list((err, res) => { if (err) { console.log(err); } else { @@ -490,7 +490,7 @@ client.relayWebhooks.list() // Callback client.relayWebhooks.update('123456789', { target: "http://client.test.com/test-webhook" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -516,12 +516,12 @@ client.relayWebhooks.update('123456789', { client.sendingDomains.create({ domain: "example1.com", dkim: { - "private": "MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/==", - "public": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==", + private: "MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/==", + public: "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==", selector: "brisbane", headers: "from:to:subject:date" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -534,8 +534,8 @@ client.sendingDomains.create({ client.sendingDomains.create({ domain: 'example1.com', dkim: { - 'private': 'MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/==', - 'public': 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==', + private: 'MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/==', + public: 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==', selector: 'brisbane', headers: 'from:to:subject:date' } @@ -550,7 +550,7 @@ client.sendingDomains.create({ }); // Callback -client.sendingDomains.delete("example1.com", function(err, data) { +client.sendingDomains.delete("example1.com", (err, data) => { if (err) { console.log(err); } else { @@ -571,7 +571,7 @@ client.sendingDomains.delete('example1.com') }); // Callback -client.sendingDomains.list(function(err, res) { +client.sendingDomains.list((err, res) => { if (err) { console.log(err); } else { @@ -592,7 +592,7 @@ client.sendingDomains.list() }); // Callback -client.sendingDomains.get('example1.com', function(err, res) { +client.sendingDomains.get('example1.com', (err, res) => { if (err) { console.log(err); } else { @@ -615,12 +615,12 @@ client.sendingDomains.get('example1.com') // Callback client.sendingDomains.update('example1.com', { dkim: { - "private": "MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/Y1g==", - "public": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==", + private: "MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/Y1g==", + public: "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==", selector: "hello_selector", headers: "from:to:subject:date" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -631,8 +631,8 @@ client.sendingDomains.update('example1.com', { client.sendingDomains.update('example1.com', { dkim: { - 'private': 'MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/Y1g==', - 'public': 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==', + private: 'MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/Y1g==', + public: 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/==', selector: 'hello_selector', headers: 'from:to:subject:date' } @@ -652,7 +652,7 @@ client.sendingDomains.verify('example1.com', { spf_verify: true, abuse_at_verify: true, postmaster_at_verify: true -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -664,7 +664,7 @@ client.sendingDomains.verify('example1.com', { // Callback client.sendingDomains.verify('example1.com', { dkim_verify: false -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -697,7 +697,7 @@ client.subaccounts.create({ "smtp/inject", "transmissions/modify" ] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -725,7 +725,7 @@ client.subaccounts.create({ }); // Callback -client.subaccounts.list(function(err, res) { +client.subaccounts.list((err, res) => { if (err) { console.log(err); } else { @@ -746,7 +746,7 @@ client.subaccounts.list() }); // Callback -client.subaccounts.get(123, function(err, res) { +client.subaccounts.get(123, (err, res) => { if (err) { console.log(err); } else { @@ -770,7 +770,7 @@ client.subaccounts.get('123') client.subaccounts.update('123', { name: "Test Subaccount", status: "suspended" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -794,7 +794,7 @@ client.subaccounts.update('123', { }); // Callback -client.suppressionList.delete('test@test.com', function(err, data) { +client.suppressionList.delete('test@test.com', (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -827,7 +827,7 @@ client.suppressionList.get('test@test.com') }); // Callback -client.suppressionList.get('test@test.com', function(err, data) { +client.suppressionList.get('test@test.com', (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -857,7 +857,7 @@ client.suppressionList.list({ from: '2015-05-07T00:00:00+0000', to: '2015-05-07T23:59:59+0000', limit: 5 -}, function(err, data) { +}, (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -868,7 +868,7 @@ client.suppressionList.list({ }); // Callback -client.suppressionList.list(function(err, data) { +client.suppressionList.list((err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -900,7 +900,7 @@ client.suppressionList.upsert({ transactional: false, non_transactional: true, description: 'Test description 1' -}, function(err, data) { +}, (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -960,7 +960,7 @@ client.suppressionList.upsert([ non_transactional: false, description: 'Test description 3' } -], function(err, data) { +], (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -979,7 +979,7 @@ client.templates.create({ subject: "Test email template!", html: "This is a test email template!" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1008,7 +1008,7 @@ client.templates.create({ }); // Callback -client.templates.delete("TEST_ID", function(err, res) { +client.templates.delete("TEST_ID", (err, res) => { if (err) { console.log(err); } else { @@ -1029,7 +1029,7 @@ client.templates.delete('TEST_ID') }); // Callback -client.templates.list(function(err, res) { +client.templates.list((err, res) => { if (err) { console.log(err); } else { @@ -1052,7 +1052,7 @@ client.templates.list() // Callback client.templates.get('TEST_ID', { draft: true -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1062,7 +1062,7 @@ client.templates.get('TEST_ID', { }); // Callback -client.templates.get('TEST_ID', function(err, res) { +client.templates.get('TEST_ID', (err, res) => { if (err) { console.log(err); } else { @@ -1085,7 +1085,7 @@ client.templates.get('TEST_ID') // Callback client.templates.preview('TEST_ID', { substitution_data: {} -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1120,7 +1120,7 @@ client.templates.update('TEST_ID', { html: "This is a published test email template! Updated!" }, }, { update_published: true }, -function(err, res) { +(err, res) => { if (err) { console.log(err); } else { @@ -1136,7 +1136,7 @@ client.templates.update('TEST_ID', { subject: "Updated Test email template!", html: "This is a test email template! Updated!" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1163,7 +1163,7 @@ client.templates.update('TEST_ID', { }); // Callback -client.transmissions.list(function(err, res) { +client.transmissions.list((err, res) => { if (err) { console.log(err); } else { @@ -1184,7 +1184,7 @@ client.transmissions.list() client.transmissions.list({ campaign_id: "my_campaign" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1195,7 +1195,7 @@ client.transmissions.list({ client.transmissions.list({ template_id: "my_template" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1205,7 +1205,7 @@ client.transmissions.list({ }); // Callback -client.transmissions.get("YOUR-TRANSMISSION-KEY", function(err, res) { +client.transmissions.get("YOUR-TRANSMISSION-KEY", (err, res) => { if (err) { console.log(err); } else { @@ -1238,7 +1238,7 @@ client.transmissions.send({ open_tracking: true, click_tracking: true } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1253,7 +1253,7 @@ client.transmissions.send({ content: { email_rfc822: "Content-Type: text/plain\nFrom: From Envelope \nSubject: Example Email\n\nHello World" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1310,7 +1310,7 @@ client.transmissions.send({ text: "Hi {{address.name}} \nSave big this Christmas in your area {{place}}! \nClick http://www.mysite.com and get huge discount\n Hurry, this offer is only to {{customer_type}}\n {{sender}}", html: "

    Hi {{address.name}} \nSave big this Christmas in your area {{place}}! \nClick http://www.mysite.com and get huge discount\n

    " } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1350,7 +1350,7 @@ client.transmissions.send({ text: "An example email using bcc with SparkPost to the {{recipient_type}} recipient.", html: "

    An example email using bcc with SparkPost to the {{recipient_type}} recipient.

    " } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1388,13 +1388,13 @@ client.transmissions.send({ email: "from@example.com" }, headers: { - "CC": "\"Carbon Copy Recipient\" " + CC: "\"Carbon Copy Recipient\" " }, subject: "Example email using cc", text: "An example email using cc with SparkPost to the {{recipient_type}} recipient.", html: "

    An example email using cc with SparkPost to the {{recipient_type}} recipient.

    " } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1414,7 +1414,7 @@ client.transmissions.send({ html: "

    Hello World

    ", text: "Hello World!" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1433,7 +1433,7 @@ client.transmissions.send({ subject: "Example Email for Stored List and Template", template_id: "my-template" } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1451,7 +1451,7 @@ client.transmissions.send({ recipients: [{ address: { email: "rick.sanchez@rickandmorty100years.com", name: "Rick Sanchez" } }] }, { num_rcpt_errors: 3 -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1460,7 +1460,6 @@ client.transmissions.send({ } }); - // Promise client.transmissions.send({ options: { @@ -1548,7 +1547,7 @@ client.transmissions.send({ email: 'from@example.com' }, headers: { - 'CC': '"Carbon Copy Recipient" ' + CC: '"Carbon Copy Recipient" ' }, subject: 'Example email using cc', text: 'An example email using cc with SparkPost to the {{recipient_type}} recipient.', @@ -1575,7 +1574,7 @@ client.webhooks.create({ "open", "click" ] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1606,7 +1605,7 @@ client.webhooks.create({ }); // Callback -client.webhooks.delete("TEST_WEBHOOK_UUID", function(err, res) { +client.webhooks.delete("TEST_WEBHOOK_UUID", (err, res) => { if (err) { console.log(err); } else { @@ -1629,7 +1628,7 @@ client.webhooks.delete('TEST_WEBHOOK_UUID') // Callback client.webhooks.get('TEST_WEBHOOK_UUID', { timezone: 'America/New_York' -}, function(err, data) { +}, (err, data) => { if (err) { console.log('Whoops! Something went wrong'); console.log(err); @@ -1655,7 +1654,7 @@ client.webhooks.get('TEST_WEBHOOK_UUID', { // Callback client.webhooks.getBatchStatus('TEST_WEBHOOK_UUID', { limit: 1000 -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1678,7 +1677,7 @@ client.webhooks.getBatchStatus('TEST_WEBHOOK_UUID', { }); // Callback -client.webhooks.getDocumentation(function(err, res) { +client.webhooks.getDocumentation((err, res) => { if (err) { console.log(err); } else { @@ -1701,7 +1700,7 @@ client.webhooks.getDocumentation() // Callback client.webhooks.getSamples({ events: "bounce" -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1724,7 +1723,7 @@ client.webhooks.getSamples({ }); // Callback -client.webhooks.list(function(err, res) { +client.webhooks.list((err, res) => { if (err) { console.log(err); } else { @@ -1751,7 +1750,7 @@ client.webhooks.update('TEST_WEBHOOK_UUID', { "policy_rejection", "delay" ] -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { @@ -1782,7 +1781,7 @@ client.webhooks.validate('TEST_WEBHOOK_UUID', { message: { msys: {} } -}, function(err, res) { +}, (err, res) => { if (err) { console.log(err); } else { diff --git a/types/sparkpost/tslint.json b/types/sparkpost/tslint.json index e77aa7b0ee..377cc837d4 100644 --- a/types/sparkpost/tslint.json +++ b/types/sparkpost/tslint.json @@ -1,8 +1 @@ -{ - "extends": "../tslint.json", - "rules": { - "only-arrow-functions-2": [ - false - ] - } -} +{ "extends": "../tslint.json" } diff --git a/types/spatialite/index.d.ts b/types/spatialite/index.d.ts index 28a4a1ae70..3edcc663c6 100644 --- a/types/spatialite/index.d.ts +++ b/types/spatialite/index.d.ts @@ -18,4 +18,3 @@ import { export class Database extends OriginalDatabase { spatialite(cb: (err: Error) => void): void; } - diff --git a/types/spatialite/spatialite-tests.ts b/types/spatialite/spatialite-tests.ts index 0edf111cc1..bac1bef4e9 100644 --- a/types/spatialite/spatialite-tests.ts +++ b/types/spatialite/spatialite-tests.ts @@ -1,9 +1,8 @@ - import spatialite = require("spatialite"); function applySpatialFunctions() { console.log(""); - var spatialDb: spatialite.Database = new spatialite.Database('spatialite', () => { + const spatialDb: spatialite.Database = new spatialite.Database('spatialite', () => { spatialDb.spatialite((err) => { if (err) { console.error(err); @@ -12,14 +11,12 @@ function applySpatialFunctions() { }); } - // Following tests taken from the sqlite3 typings spatialite.verbose(); // This line is enhanced to fulfill the `strictNullChecks` option -var db: spatialite.Database = new spatialite.Database('chain.sqlite3', () => {}); -// var db: spatialite.Database +let db: spatialite.Database = new spatialite.Database('chain.sqlite3', () => {}); function createDb() { console.log("createDb chain"); @@ -33,9 +30,9 @@ function createTable() { function insertRows() { console.log("insertRows Ipsum i"); - var stmt = db.prepare("INSERT INTO lorem VALUES (?)"); + const stmt = db.prepare("INSERT INTO lorem VALUES (?)"); - for (var i = 0; i < 10; i++) { + for (let i = 0; i < 10; i++) { stmt.run("Ipsum " + i); } @@ -73,8 +70,8 @@ runChainExample(); db.serialize(() => { db.run("CREATE TABLE lorem (info TEXT)"); - var stmt = db.prepare("INSERT INTO lorem VALUES (?)"); - for (var i = 0; i < 10; i++) { + const stmt = db.prepare("INSERT INTO lorem VALUES (?)"); + for (let i = 0; i < 10; i++) { stmt.run("Ipsum " + i); } stmt.finalize(); diff --git a/types/sshpk/index.d.ts b/types/sshpk/index.d.ts index 0bc2274120..6089dd930b 100644 --- a/types/sshpk/index.d.ts +++ b/types/sshpk/index.d.ts @@ -5,19 +5,16 @@ /// -declare class SshPK { -} +declare class SshPK {} declare namespace SshPK { - - export class Algo { + class Algo { parts: string[]; sizePart?: string; normalize?: boolean; } - - export class algInfo { + class algInfo { dsa: Algo; rsa: Algo; ecdsa: Algo; @@ -25,7 +22,7 @@ declare namespace SshPK { curve25519: Algo; } - export class algPrivInfo { + class algPrivInfo { dsa: Algo; rsa: Algo; ecdsa: Algo; @@ -33,7 +30,7 @@ declare namespace SshPK { curve25519: Algo; } - export class hashAlgs { + class hashAlgs { md5: boolean; sha1: boolean; sha256: boolean; @@ -41,7 +38,7 @@ declare namespace SshPK { sha512: boolean; } - export class Curve { + class Curve { size: number; pkcs8oid: string; p: Buffer; @@ -52,21 +49,20 @@ declare namespace SshPK { G: Buffer; } - export class curves { + class curves { nistp256: Curve; nistp384: Curve; nistp512: Curve; } - export class algs { + class algs { info: algInfo; privInfo: algPrivInfo; hashAlgs: hashAlgs; curves: curves; } - - export class Certificate { + class Certificate { subjects: Identity[]; issuer: string; subjectKey: string; @@ -101,12 +97,9 @@ declare namespace SshPK { static parse(data: string|Buffer, format: string, options: any): Certificate; static isCertificate(data: string|Buffer, ver: string): boolean; - } - - export class DiffieHellman { - + class DiffieHellman { constructor(key: Key); getPublicKey(): Key; @@ -121,24 +114,23 @@ declare namespace SshPK { generateKeys(): PrivateKey; } - export class X9ECParameters { + class X9ECParameters { G: any; g: any; n: any; h: any; } - export class ECPublic { + class ECPublic { constructor(params: X9ECParameters, buffer: Buffer); } - export class ECPrivate { + class ECPrivate { constructor(params: X9ECParameters, buffer: Buffer); deriveSharedSecret(pk: Key): Buffer; } - - export class Verifier { + class Verifier { constructor(key: Key, hashAlgo: string); update(chunk: string|Buffer): void; @@ -146,53 +138,50 @@ declare namespace SshPK { verify(signature: string): boolean; } - export class Signer { - + class Signer { constructor(key: Key, hashAlgo: string); update(chunk: string|Buffer): void; sign(): Signature; } - - export class FingerprintFormatError implements Error { + class FingerprintFormatError implements Error { name: string; message: string; constructor(fp: Fingerprint, format: string); } - export class InvalidAlgorithmError implements Error { + class InvalidAlgorithmError implements Error { name: string; message: string; constructor(algo: string); } - export class KeyParseError implements Error { + class KeyParseError implements Error { name: string; message: string; constructor(name: string, format: string, innerErr: any); } - export class SignatureParseError implements Error { + class SignatureParseError implements Error { name: string; message: string; constructor(type: string, format: string, innerErr: any); } - export class CertificateParseError implements Error { + class CertificateParseError implements Error { name: string; message: string; constructor(name: string, format: string, innerErr: any); } - export class KeyEncryptedError implements Error { + class KeyEncryptedError implements Error { name: string; message: string; constructor(name: string, format: string); } - - export class Fingerprint { + class Fingerprint { algorithm: string; hash: string; type: string; @@ -206,10 +195,9 @@ declare namespace SshPK { isFingerprint(obj: string|Buffer, ver: string): boolean; static parse(fp: string, options: any): Fingerprint; - } - export class Identity { + class Identity { cn: string; components: string[]; componentLookup: any; @@ -233,13 +221,12 @@ declare namespace SshPK { static isIdentity(dn: Buffer|string, ver: string): boolean; } - - export class Format { + class Format { read: (buf: Buffer, options?: any) => Buffer; write: (key: Key, options?: any) => Buffer; } - export class Formats { + class Formats { auto: Format; pem: Format; pkcs1: Format; @@ -250,11 +237,11 @@ declare namespace SshPK { openssh: Format; } - export class Verify { + class Verify { verify(data: string, fmt: string): boolean; } - export class Key { + class Key { type: string; parts: string; part: string; @@ -278,10 +265,9 @@ declare namespace SshPK { static parse(data: string|Buffer, format: string, options: any): Key; static isKey(obj: string|Buffer, ver: string): boolean; - } - export class PrivateKey { + class PrivateKey { constructor(opts: any); static formats: Formats; toBuffer(format: string, options: any): Buffer; @@ -293,11 +279,9 @@ declare namespace SshPK { static parse(data: string|Buffer, format: string, options: any): PrivateKey; static isPrivateKey(data: string|Buffer, ver: string): boolean; - } - - export class Signature { + class Signature { constructor(opts: any); toBuffer(format: string): Buffer; toString(format: string): string; @@ -305,14 +289,13 @@ declare namespace SshPK { static parse(data: string|Buffer, type: string, format: string): Signature; static isSignature(obj: string|Buffer, ver: string): boolean; - } - export class SSHPart { + class SSHPart { data: Buffer; } - export class SSHBuffer { + class SSHBuffer { constructor(opts: any); toBuffer(): Buffer; atEnd(): boolean; @@ -333,47 +316,44 @@ declare namespace SshPK { writeChar(buf: string): void; writePart(buf: SSHPart): void; write(buf: Buffer): void; - } - - export function bufferSplit(buf: Buffer, chr: string): Buffer[]; - export function addRSAMissing(key: PrivateKey): void; - export function calculateDSAPublic(g: Buffer, p: Buffer, x: Buffer): Buffer; - export function mpNormalize(buf: Buffer): Buffer; - export function ecNormalize(buf: Buffer, addZero: boolean): Buffer; - export function countZeros(buf: Buffer): number; - export function assertCompatible(obj: any, klass: any, needVer: string, name: string): void; - export function isCompatible(obj: any, klass: any, needVer: string): boolean; - export class OpenSllKeyDeriv { + function bufferSplit(buf: Buffer, chr: string): Buffer[]; + function addRSAMissing(key: PrivateKey): void; + function calculateDSAPublic(g: Buffer, p: Buffer, x: Buffer): Buffer; + function mpNormalize(buf: Buffer): Buffer; + function ecNormalize(buf: Buffer, addZero: boolean): Buffer; + function countZeros(buf: Buffer): number; + function assertCompatible(obj: any, klass: any, needVer: string, name: string): void; + function isCompatible(obj: any, klass: any, needVer: string): boolean; + class OpenSllKeyDeriv { key: Buffer; iv: Buffer; } - export function opensslKeyDeriv(cipher: string, salt: string, passphrase: string, count: number): OpenSllKeyDeriv; + function opensslKeyDeriv(cipher: string, salt: string, passphrase: string, count: number): OpenSllKeyDeriv; - export class OpensshCipherInfo { + class OpensshCipherInfo { keySize: number; blockSize: number; opensslName: string; } - export function opensshCipherInfo(cipber: string): OpensshCipherInfo; + function opensshCipherInfo(cipber: string): OpensshCipherInfo; - export function parseKey(data: string|Buffer, format: string, options?: any): Key; - export function parseFingerprint(fp: string, options?: any): Fingerprint; - export function parseSignature(data: string|Buffer, type: string, format: string): Signature; - export function parsePrivateKey(data: string|Buffer, format: string, options?: any): PrivateKey; + function parseKey(data: string|Buffer, format: string, options?: any): Key; + function parseFingerprint(fp: string, options?: any): Fingerprint; + function parseSignature(data: string|Buffer, type: string, format: string): Signature; + function parsePrivateKey(data: string|Buffer, format: string, options?: any): PrivateKey; - export function parseCertificate(data: string|Buffer, format: string, options?: any): Certificate; - export function createSelfSignedCertificate(subjectOrSubjects: string, key: Key, options?: any): Certificate; - export function createCertificate( + function parseCertificate(data: string|Buffer, format: string, options?: any): Certificate; + function createSelfSignedCertificate(subjectOrSubjects: string, key: Key, options?: any): Certificate; + function createCertificate( subjectOrSubjects: string, key: Key, issuer: string, issuerKey: PrivateKey, options?: any): Certificate; - export function identityFromDN(dn: string): Identity; - export function identityForHost(hostname: string): Identity; - export function identityForUser(uid: string): Identity; - export function identityForEmail(email: string): Identity; - + function identityFromDN(dn: string): Identity; + function identityForHost(hostname: string): Identity; + function identityForUser(uid: string): Identity; + function identityForEmail(email: string): Identity; } export = SshPK; diff --git a/types/sshpk/sshpk-tests.ts b/types/sshpk/sshpk-tests.ts index 301534d908..9caf27160d 100644 --- a/types/sshpk/sshpk-tests.ts +++ b/types/sshpk/sshpk-tests.ts @@ -1,4 +1,3 @@ - import * as sshpk from 'sshpk'; const cert = sshpk.parseCertificate("", "pem"); diff --git a/types/stream-buffers/index.d.ts b/types/stream-buffers/index.d.ts index aa0602b835..59cf0e1df1 100644 --- a/types/stream-buffers/index.d.ts +++ b/types/stream-buffers/index.d.ts @@ -15,7 +15,7 @@ export class WritableStreamBuffer extends stream.Writable { constructor(options?: WritableStreamBufferOptions); size(): number; maxSize(): number; - getContents(length?: number): any; + getContents(length?: number): Buffer; getContentsAsString(encoding?: string, length?: number): string; } diff --git a/types/stream-buffers/stream-buffers-tests.ts b/types/stream-buffers/stream-buffers-tests.ts index c7051023b8..b50a1db286 100644 --- a/types/stream-buffers/stream-buffers-tests.ts +++ b/types/stream-buffers/stream-buffers-tests.ts @@ -20,16 +20,16 @@ myWritableStreamBuffer.size(); myWritableStreamBuffer.maxSize(); // Gets all held data as a Buffer. -myWritableStreamBuffer.getContents(); +const contents: Buffer = myWritableStreamBuffer.getContents(); // Gets all held data as a utf8 string. -myWritableStreamBuffer.getContentsAsString('utf8'); +const stringContents: string = myWritableStreamBuffer.getContentsAsString('utf8'); // Gets first 5 bytes as a Buffer. -myWritableStreamBuffer.getContents(5); +const contents2: Buffer = myWritableStreamBuffer.getContents(5); // Gets first 5 bytes as a utf8 string. -myWritableStreamBuffer.getContentsAsString('utf8', 5); +const stringContents2: string = myWritableStreamBuffer.getContentsAsString('utf8', 5); const myReadableStreamBuffer = new streamBuffers.ReadableStreamBuffer({ frequency: 10, // in milliseconds. diff --git a/types/stringify-object/index.d.ts b/types/stringify-object/index.d.ts index bfccb83300..3380fc3672 100644 --- a/types/stringify-object/index.d.ts +++ b/types/stringify-object/index.d.ts @@ -8,7 +8,7 @@ declare namespace stringifyObject { } declare function stringifyObject(o: any, options?: { indent?: string, singleQuotes?: boolean, - filter?: (o: any, prop: string) => boolean, + filter?(o: any, prop: string): boolean, inlineCharacterLimit?: number }): string; diff --git a/types/strip-ansi/strip-ansi-tests.ts b/types/strip-ansi/strip-ansi-tests.ts index 12e60b5e82..a39d45bd86 100644 --- a/types/strip-ansi/strip-ansi-tests.ts +++ b/types/strip-ansi/strip-ansi-tests.ts @@ -1,4 +1,4 @@ import stripAnsi = require('strip-ansi'); stripAnsi('\u001b[4mcake\u001b[0m'); -// => 'cake' \ No newline at end of file +// => 'cake' diff --git a/types/strip-bom/strip-bom-tests.ts b/types/strip-bom/strip-bom-tests.ts index 79aaa3daae..29e544db98 100644 --- a/types/strip-bom/strip-bom-tests.ts +++ b/types/strip-bom/strip-bom-tests.ts @@ -1,4 +1,4 @@ import stripBom = require('strip-bom'); stripBom('\uFEFFunicorn'); -// => 'unicorn' \ No newline at end of file +// => 'unicorn' diff --git a/types/supertest-as-promised/supertest-as-promised-tests.ts b/types/supertest-as-promised/supertest-as-promised-tests.ts index 23e47ee319..b86bdafbc9 100644 --- a/types/supertest-as-promised/supertest-as-promised-tests.ts +++ b/types/supertest-as-promised/supertest-as-promised-tests.ts @@ -4,7 +4,7 @@ import * as express from 'express'; declare function describe(desc: string, f: () => void): void; declare function it(desc: string, f: () => void): void; -var app = express(); +const app = express(); // chain your requests like you were promised: request(app) @@ -20,7 +20,6 @@ request(app) // ... }); - // Usage request(app) .get("/kittens") @@ -29,11 +28,10 @@ request(app) // ... }); - request(app).get("/kittens").expect(200); // Agents -var agent = request.agent(app); +const agent = request.agent(app); agent .get("/ugly-kitteh") .expect(404) @@ -41,7 +39,6 @@ agent // ... }); - // Promisey goodness request(app) .get("/kittens") diff --git a/types/swagger-express-mw/swagger-express-mw-tests.ts b/types/swagger-express-mw/swagger-express-mw-tests.ts index a066071758..617e331e1c 100644 --- a/types/swagger-express-mw/swagger-express-mw-tests.ts +++ b/types/swagger-express-mw/swagger-express-mw-tests.ts @@ -16,12 +16,10 @@ SwaggerExpress.create(config, (err, middleware) => { app.listen(port); }); - const swaggerSecurityHandlerCb = (err: Error) => { // do nothing }; - const configComplex: SwaggerExpress.Config = { appRoot: __dirname, configDir: "some/directory", diff --git a/types/swagger-hapi/swagger-hapi-tests.ts b/types/swagger-hapi/swagger-hapi-tests.ts index 3d894aafba..1793887ec3 100644 --- a/types/swagger-hapi/swagger-hapi-tests.ts +++ b/types/swagger-hapi/swagger-hapi-tests.ts @@ -1,18 +1,18 @@ import * as SwaggerHapi from "swagger-hapi"; import * as Hapi from "hapi"; -var app = new Hapi.Server(); +const app = new Hapi.Server(); module.exports = app; // for testing -var config = { +const config = { appRoot: __dirname // required config } as SwaggerHapi.Config; SwaggerHapi.create(config, (err, swaggerHapi) => { if (err) { throw err; } - var port = process.env.PORT || 10010; + const port = process.env.PORT || 10010; app.connection({ port }); // app.address = function() { // return { port }; @@ -28,12 +28,10 @@ SwaggerHapi.create(config, (err, swaggerHapi) => { }); }); - const swaggerSecurityHandlerCb = (err: Error) => { // do nothing }; - const configComplex: SwaggerHapi.Config = { appRoot: __dirname, configDir: "some/directory", diff --git a/types/swagger-node-runner/index.d.ts b/types/swagger-node-runner/index.d.ts index 61880b3f8d..abb0d991ef 100644 --- a/types/swagger-node-runner/index.d.ts +++ b/types/swagger-node-runner/index.d.ts @@ -45,19 +45,19 @@ export interface Config { /** If `true` API is in mock mode * * default is `false` - */ + */ mockMode?: boolean; /** If `true` resonse is validated * * default is `true` - */ + */ validateResponse?: boolean; /** Sets `NODE_CONFIG_DIR` env if not set yet */ configDir?: string; /** Swagger controller directories * * default is array with `/api/controllers` relative to `appRoot` - */ + */ controllersDirs?: string[]; /** Swagger mock controller directories * @@ -126,9 +126,9 @@ interface SwaggerSecurityHandlers { export interface Runner extends EventEmitter { /** Resolves path (relative to `config.appRoot`) */ resolveAppPath(...to: any[]): string; - defaultErrorHandler: () => any; + defaultErrorHandler(): any; /** Fetch a _bagpipe_ pipe */ - getPipe: (req: { swagger: { path: any } }) => any; + getPipe(req: { swagger: { path: any } }): any; config: ConfigInternal; /** * Current OpenAPI Specification (formaly known as Swagger RESTful API Documentation Specification) @@ -148,7 +148,7 @@ export interface Runner extends EventEmitter { * * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/middleware/swagger-metadata.js|Git Source} */ - swaggerMetadata: (rlOrSO: any, apiDeclarations: any[]) => SwaggerToolsMiddleware + swaggerMetadata(rlOrSO: any, apiDeclarations: any[]): SwaggerToolsMiddleware /** * Middleware for using Swagger information to route requests to handlers. * @param [{any}] options - The configuration options @@ -156,14 +156,14 @@ export interface Runner extends EventEmitter { * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md#swaggerrouteroptions|Docs} * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/middleware/swagger-router.js|Github Source} */ - swaggerRouter: (options?: any) => SwaggerToolsMiddleware + swaggerRouter(options?: any): SwaggerToolsMiddleware /** * Middleware for using Swagger security information to authenticate requests. * @param [{any}] options - The configuration options * * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/middleware/swagger-security.js|Github Source} */ - swaggerSecurity: (options?: SwaggerSecurityHandlers) => SwaggerToolsMiddleware + swaggerSecurity(options?: SwaggerSecurityHandlers): SwaggerToolsMiddleware /** * Middleware for serving the Swagger documents and Swagger UI. * @@ -173,14 +173,14 @@ export interface Runner extends EventEmitter { * * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/middleware/swagger-ui.js|Github Source} */ - swaggerUi: (rlOrSO: any, apiDeclarations: any[], options?: any) => SwaggerToolsMiddleware + swaggerUi(rlOrSO: any, apiDeclarations: any[], options?: any): SwaggerToolsMiddleware /** * Middleware for using Swagger information to validate API requests/responses.type * @param [{any}] options - The configuration options * * @see {@link https://github.com/apigee-127/swagger-tools/blob/master/middleware/swagger-validator.js|Github Source} */ - swaggerValidator: (options?: any) => SwaggerToolsMiddleware + swaggerValidator(options?: any): SwaggerToolsMiddleware }; swaggerSecurityHandlers: SwaggerSecurityHandlers | undefined; /** @@ -189,15 +189,15 @@ export interface Runner extends EventEmitter { */ bagpipes: { [name: string]: any }; /** Create new Connect middleware */ - connectMiddleware: () => ConnectMiddleware; + connectMiddleware(): ConnectMiddleware; /** Create new Express middleware */ - expressMiddleware: () => ExpressMiddleware; + expressMiddleware(): ExpressMiddleware; /** Create new Restify middleware */ - restifyMiddleware: () => RestifyMiddleware; + restifyMiddleware(): RestifyMiddleware; /** Create new Sails middleware */ - sailsMiddleware: () => SailsMiddleware; + sailsMiddleware(): SailsMiddleware; /** Create new Hapi middleware */ - hapiMiddleware: () => HapiMiddleware; + hapiMiddleware(): HapiMiddleware; } /** base used by all middleware versions */ @@ -208,9 +208,9 @@ interface Middleware { /** Connect/Express specific Middleware */ export interface ConnectMiddleware extends Middleware { - middleware: () => (req: Express.Request, res: Express.Response, next: NextFunction) => void; + middleware(): (req: Express.Request, res: Express.Response, next: NextFunction) => void; /** Register this Middleware with `app` */ - register: (app: Express.Application) => void; + register(app: Express.Application): void; } /** Express specific Middleware * @@ -222,7 +222,7 @@ export interface ExpressMiddleware extends ConnectMiddleware { } /** Sails specific Middleware */ export interface SailsMiddleware extends Middleware { /** Express style middleware */ - chain: () => (req: Express.Request, res: Express.Response, next: NextFunction) => void; + chain(): (req: Express.Request, res: Express.Response, next: NextFunction) => void; } /** Hapi specific Middleware */ @@ -249,7 +249,7 @@ export interface HapiMiddleware extends Middleware { attributes: { /** Name of Plugin (e.g. `swagger-node-runner`) */ name: string - /** Version of Plugin*/ + /** Version of Plugin */ version: string } } @@ -259,10 +259,9 @@ export interface HapiMiddleware extends Middleware { /** Restify specific Middleware */ export interface RestifyMiddleware extends Middleware { /** Register this Middleware with `app` */ - register: (app: Restify.Server) => void; + register(app: Restify.Server): void; } - /** * Create new SwaggerNodeRunner Instance * diff --git a/types/swagger-node-runner/swagger-node-runner-tests.ts b/types/swagger-node-runner/swagger-node-runner-tests.ts index cff8e9d570..c0fd698df1 100644 --- a/types/swagger-node-runner/swagger-node-runner-tests.ts +++ b/types/swagger-node-runner/swagger-node-runner-tests.ts @@ -22,7 +22,6 @@ SwaggerNodeRunner.create(config, (err, runner) => { expressApp.listen(port); }); - // Connect middleware const connectApp = connect(); SwaggerNodeRunner.create(config, (err, runner) => { @@ -31,11 +30,10 @@ SwaggerNodeRunner.create(config, (err, runner) => { const connectMiddleware = runner.connectMiddleware(); connectMiddleware.register(connectApp); - var port = process.env.PORT || 10010; + const port = process.env.PORT || 10010; connectApp.listen(port); }); - // Sails Middleware (chain) test SwaggerNodeRunner.create(config, (err, runner) => { if (err) { throw err; } @@ -46,13 +44,12 @@ SwaggerNodeRunner.create(config, (err, runner) => { } }); - // Hapi Middleware -var hapiapp = new Hapi.Server(); +const hapiapp = new Hapi.Server(); SwaggerNodeRunner.create(config, (err, runner) => { if (err) { throw err; } - var port = process.env.PORT || 10010; + const port = process.env.PORT || 10010; hapiapp.connection({ port }); // hapiapp.address = function() { // return { port }; @@ -71,7 +68,6 @@ SwaggerNodeRunner.create(config, (err, runner) => { }); }); - // Restify Middelware const app = restify.createServer(); SwaggerNodeRunner.create(config, (err, runner) => { @@ -85,12 +81,10 @@ SwaggerNodeRunner.create(config, (err, runner) => { app.listen(port); }); - const swaggerSecurityHandlerCb = (err: Error) => { // do nothing }; - const configComplex: SwaggerNodeRunner.Config = { appRoot: __dirname, configDir: "some/directory", diff --git a/types/swagger-restify-mw/swagger-restify-mw-tests.ts b/types/swagger-restify-mw/swagger-restify-mw-tests.ts index 73568b2153..629c85ecf3 100644 --- a/types/swagger-restify-mw/swagger-restify-mw-tests.ts +++ b/types/swagger-restify-mw/swagger-restify-mw-tests.ts @@ -16,12 +16,10 @@ SwaggerRestify.create(config, (err, swaggerRestify) => { app.listen(port); }); - const swaggerSecurityHandlerCb = (err: Error) => { // do nothing }; - const configComplex: SwaggerRestify.Config = { appRoot: __dirname, configDir: "some/directory", diff --git a/types/swagger-sails-hook/index.d.ts b/types/swagger-sails-hook/index.d.ts index 6d474c1907..b2e54f10a0 100644 --- a/types/swagger-sails-hook/index.d.ts +++ b/types/swagger-sails-hook/index.d.ts @@ -21,11 +21,11 @@ declare function SwaggerHook(sails: any): SwaggerHook.SailsHook; declare namespace SwaggerHook { /** - * `swagger-sails-hook` object implementing the Sails' hook specification. - * - * @see {@link http://sailsjs.com/documentation/concepts/extending-sails/hooks/hook-specification|Sails Hook Docs} - * @see {@link http://sailsjs.com/documentation/anatomy/api/hooks/my-hook/index-js|Sails Hook Example} - */ + * `swagger-sails-hook` object implementing the Sails' hook specification. + * + * @see {@link http://sailsjs.com/documentation/concepts/extending-sails/hooks/hook-specification|Sails Hook Docs} + * @see {@link http://sailsjs.com/documentation/anatomy/api/hooks/my-hook/index-js|Sails Hook Example} + */ interface SailsHook { /** * Perform startup tasks. diff --git a/types/swiper/index.d.ts b/types/swiper/index.d.ts index 99cdc714d9..e74fc923f9 100644 --- a/types/swiper/index.d.ts +++ b/types/swiper/index.d.ts @@ -97,10 +97,10 @@ interface SwiperOptions { paginationHide?: boolean; paginationClickable?: boolean; paginationElement?: string; - paginationBulletRender?: (swiper: Swiper, index: number, className: string) => void; - paginationFractionRender?: (swiper: Swiper, currentClassName: string, totalClassName: string) => void; - paginationProgressRender?: (swiper: Swiper, progressbarClass: string) => void; - paginationCustomRender?: (swiper: Swiper, current: number, total: number) => void; + paginationBulletRender?(swiper: Swiper, index: number, className: string): void; + paginationFractionRender?(swiper: Swiper, currentClassName: string, totalClassName: string): void; + paginationProgressRender?(swiper: Swiper, progressbarClass: string): void; + paginationCustomRender?(swiper: Swiper, current: number, total: number): void; // Navigation Buttons nextButton?: string | Element; @@ -112,7 +112,6 @@ interface SwiperOptions { scrollbarDraggable?: boolean; scrollbarSnapOnRelease?: boolean; - // Accessibility a11y?: boolean; prevSlideMessage?: string; @@ -121,7 +120,6 @@ interface SwiperOptions { lastSlideMessage?: string; paginationBulletMessage?: string; - // Keyboard / Mousewheel keyboardControl?: boolean; mousewheelControl?: boolean; @@ -135,7 +133,6 @@ interface SwiperOptions { hashnavWatchState?: boolean; history?: string; - // Images preloadImages?: boolean; updateOnImagesReady?: boolean; @@ -165,36 +162,36 @@ interface SwiperOptions { // Callbacks runCallbacksOnInit?: boolean; - onInit?: (swiper: Swiper) => void; - onSlideChangeStart?: (swiper: Swiper) => void; - onSlideChangeEnd?: (swiper: Swiper) => void; - onSlideNextStart?: (swiper: Swiper) => void; - onSlideNextEnd?: (swiper: Swiper) => void; - onSlidePrevStart?: (swiper: Swiper) => void; - onSlidePrevEnd?: (swiper: Swiper) => void; - onTransitionStart?: (swiper: Swiper) => void; - onTransitionEnd?: (swiper: Swiper) => void; - onTouchStart?: (swiper: Swiper, event: Event) => void; - onTouchMove?: (swiper: Swiper, event: Event) => void; - onTouchMoveOpposite?: (swiper: Swiper, event: Event) => void; - onSliderMove?: (swiper: Swiper, event: Event) => void; - onTouchEnd?: (swiper: Swiper, event: Event) => void; - onClick?: (swiper: Swiper, event: Event) => void; - onTap?: (swiper: Swiper, event: Event) => void; - onDoubleTap?: (swiper: Swiper, event: Event) => void; - onImagesReady?: (swiper: Swiper) => void; - onProgress?: (swiper: Swiper, progress: number) => void; - onReachBeginning?: (swiper: Swiper) => void; - onReachEnd?: (swiper: Swiper) => void; - onDestroy?: (swiper: Swiper) => void; - onSetTranslate?: (swiper: Swiper, translate: any) => void; - onSetTransition?: (swiper: Swiper, transition: any) => void; - onAutoplay?: (swiper: Swiper) => void; - onAutoplayStart?: (swiper: Swiper) => void; - onAutoplayStop?: (swiper: Swiper) => void; - onLazyImageLoad?: (swiper: Swiper, slide: any, image: any) => void; - onLazyImageReady?: (swiper: Swiper, slide: any, image: any) => void; - onPaginationRendered?: (swiper: Swiper, paginationContainer: any) => void; + onInit?(swiper: Swiper): void; + onSlideChangeStart?(swiper: Swiper): void; + onSlideChangeEnd?(swiper: Swiper): void; + onSlideNextStart?(swiper: Swiper): void; + onSlideNextEnd?(swiper: Swiper): void; + onSlidePrevStart?(swiper: Swiper): void; + onSlidePrevEnd?(swiper: Swiper): void; + onTransitionStart?(swiper: Swiper): void; + onTransitionEnd?(swiper: Swiper): void; + onTouchStart?(swiper: Swiper, event: Event): void; + onTouchMove?(swiper: Swiper, event: Event): void; + onTouchMoveOpposite?(swiper: Swiper, event: Event): void; + onSliderMove?(swiper: Swiper, event: Event): void; + onTouchEnd?(swiper: Swiper, event: Event): void; + onClick?(swiper: Swiper, event: Event): void; + onTap?(swiper: Swiper, event: Event): void; + onDoubleTap?(swiper: Swiper, event: Event): void; + onImagesReady?(swiper: Swiper): void; + onProgress?(swiper: Swiper, progress: number): void; + onReachBeginning?(swiper: Swiper): void; + onReachEnd?(swiper: Swiper): void; + onDestroy?(swiper: Swiper): void; + onSetTranslate?(swiper: Swiper, translate: any): void; + onSetTransition?(swiper: Swiper, transition: any): void; + onAutoplay?(swiper: Swiper): void; + onAutoplayStart?(swiper: Swiper): void; + onAutoplayStop?(swiper: Swiper): void; + onLazyImageLoad?(swiper: Swiper, slide: any, image: any): void; + onLazyImageReady?(swiper: Swiper, slide: any, image: any): void; + onPaginationRendered?(swiper: Swiper, paginationContainer: any): void; // Namespace slideClass?: string; @@ -321,7 +318,7 @@ declare class Swiper { setGrabCursor(): void; plugins?: { - debugger?: (swiper: any, params: any) => void; + debugger?(swiper: any, params: any): void; }; } diff --git a/types/swiper/swiper-tests.ts b/types/swiper/swiper-tests.ts index 6decd155e0..7e772a2742 100644 --- a/types/swiper/swiper-tests.ts +++ b/types/swiper/swiper-tests.ts @@ -1,4 +1,3 @@ - /// // @@ -7,18 +6,18 @@ // 01-default.html function defaultDemo() { - var swiper = new Swiper('.swiper-container'); + const swiper = new Swiper('.swiper-container'); } // 02-responsive.html function responsive() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true }); } // 03-vertical.html function vertical() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, direction: 'vertical' @@ -26,7 +25,7 @@ function vertical() { } // 04-space-between.html function spaceBetween() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, spaceBetween: 30, @@ -34,7 +33,7 @@ function spaceBetween() { } // 05-slides-per-view.html function slidesPerView() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 3, paginationClickable: true, @@ -43,7 +42,7 @@ function slidesPerView() { } // 06-slides-per-view-auto.html function slidesPerViewAuto() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 'auto', paginationClickable: true, @@ -52,7 +51,7 @@ function slidesPerViewAuto() { } // 07-centered.html function centered() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 4, centeredSlides: true, @@ -62,7 +61,7 @@ function centered() { } // 08-centered-auto.html function centeredAuto() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 'auto', centeredSlides: true, @@ -72,7 +71,7 @@ function centeredAuto() { } // 09-freemode.html function freemode() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 3, paginationClickable: true, @@ -82,7 +81,7 @@ function freemode() { } // 10-slides-per-column.html function slidesPerColumn() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 3, slidesPerColumn: 2, @@ -92,12 +91,12 @@ function slidesPerColumn() { } // 11-nested.html function nested() { - var swiperH = new Swiper('.swiper-container-h', { + const swiperH = new Swiper('.swiper-container-h', { pagination: '.swiper-pagination-h', paginationClickable: true, spaceBetween: 50 }); - var swiperV = new Swiper('.swiper-container-v', { + const swiperV = new Swiper('.swiper-container-v', { pagination: '.swiper-pagination-v', paginationClickable: true, direction: 'vertical', @@ -106,7 +105,7 @@ function nested() { } // 12-grab-cursor.html function grabCursor() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 4, centeredSlides: true, @@ -117,7 +116,7 @@ function grabCursor() { } // 13-scrollbar.html function scrollbar() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { scrollbar: '.swiper-scrollbar', scrollbarHide: true, slidesPerView: 'auto', @@ -128,7 +127,7 @@ function scrollbar() { } // 14-nav-arrows.html function navArrows() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -138,7 +137,7 @@ function navArrows() { } // 15-infinite-loop.html function infiniteLoop() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', @@ -150,7 +149,7 @@ function infiniteLoop() { } // 16-effect-fade.html function effectFade() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -161,7 +160,7 @@ function effectFade() { } // 17-effect-cube.html function effectCube() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', effect: 'cube', grabCursor: true, @@ -175,7 +174,7 @@ function effectCube() { } // 18-effect-coverflow.html function effectCoverflow() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', effect: 'coverflow', grabCursor: true, @@ -192,7 +191,7 @@ function effectCoverflow() { } // 19-keyboard-control.html function keyboardControl() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', slidesPerView: 1, paginationClickable: true, @@ -204,7 +203,7 @@ function keyboardControl() { } // 20-mousewheel-control.html function mousewheelControl() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', direction: 'vertical', slidesPerView: 1, @@ -215,7 +214,7 @@ function mousewheelControl() { } // 21-autoplay.html function autoplay() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', @@ -228,9 +227,9 @@ function autoplay() { } // 22-dynamic-slides.html function dynamicSlides() { - var appendNumber = 4; - var prependNumber = 1; - var swiper = new Swiper('.swiper-container', { + let appendNumber = 4; + let prependNumber = 1; + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', @@ -264,14 +263,14 @@ function dynamicSlides() { } // 23-thumbs-gallery-loop.html function thumbsGalleryLoop() { - var galleryTop = new Swiper('.gallery-top', { + const galleryTop = new Swiper('.gallery-top', { nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', spaceBetween: 10, loop: true, loopedSlides: 5, // looped slides should be the same }); - var galleryThumbs = new Swiper('.gallery-thumbs', { + const galleryThumbs = new Swiper('.gallery-thumbs', { spaceBetween: 10, slidesPerView: 4, touchRatio: 0.2, @@ -281,16 +280,15 @@ function thumbsGalleryLoop() { }); galleryTop.params.control = galleryThumbs; galleryThumbs.params.control = galleryTop; - } // 23-thumbs-gallery.html function thumbsGallery() { - var galleryTop = new Swiper('.gallery-top', { + const galleryTop = new Swiper('.gallery-top', { nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', spaceBetween: 10, }); - var galleryThumbs = new Swiper('.gallery-thumbs', { + const galleryThumbs = new Swiper('.gallery-thumbs', { spaceBetween: 10, centeredSlides: true, slidesPerView: 'auto', @@ -299,21 +297,20 @@ function thumbsGallery() { }); galleryTop.params.control = galleryThumbs; galleryThumbs.params.control = galleryTop; - } // 24-multiple-swipers.html function multipleSwipers() { - var swiper1 = new Swiper('.swiper1', { + const swiper1 = new Swiper('.swiper1', { pagination: '.swiper-pagination1', paginationClickable: true, spaceBetween: 30, }); - var swiper2 = new Swiper('.swiper2', { + const swiper2 = new Swiper('.swiper2', { pagination: '.swiper-pagination2', paginationClickable: true, spaceBetween: 30, }); - var swiper3 = new Swiper('.swiper3', { + const swiper3 = new Swiper('.swiper3', { pagination: '.swiper-pagination3', paginationClickable: true, spaceBetween: 30, @@ -321,7 +318,7 @@ function multipleSwipers() { } // 25-hash-navigation.html function hashNavigation() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -333,7 +330,7 @@ function hashNavigation() { } // 26-rtl.html function rtl() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -342,7 +339,7 @@ function rtl() { } // 27-jquery.html function jquery() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -351,7 +348,7 @@ function jquery() { } // 28-parallax.html function parallax() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -362,7 +359,7 @@ function parallax() { } // 29-custom-pagination.html function customPagination() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, paginationBulletRender(swiper, index, className) { @@ -372,7 +369,7 @@ function customPagination() { } // 30-lazy-load-images.html function lazyLoadImages() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', pagination: '.swiper-pagination', @@ -430,7 +427,7 @@ function customPlugin() { } // 32-scroll-container.html function scrollContainer() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { scrollbar: '.swiper-scrollbar', direction: 'vertical', slidesPerView: 'auto', @@ -440,34 +437,34 @@ function scrollContainer() { } // 32-slideable-menu.html function slideableMenu() { - var toggleMenu = () => { + const toggleMenu = () => { if (swiper.previousIndex === 0) swiper.slidePrev(); - } - , menuButton = document.getElementsByClassName('menu-button')[0] - , swiper = new Swiper('.swiper-container', { - slidesPerView: 'auto' - , initialSlide: 1 - , resistanceRatio: .00000000000001 - , onSlideChangeStart: (slider) => { - if (slider.activeIndex === 0) { - menuButton.classList.add('cross'); - menuButton.removeEventListener('click', toggleMenu, false); - } else - menuButton.classList.remove('cross'); - } - , onSlideChangeEnd: (slider) => { - if (slider.activeIndex === 0) - menuButton.removeEventListener('click', toggleMenu, false); - else - menuButton.addEventListener('click', toggleMenu, false); - } - , slideToClickedSlide: true - }); + }; + const menuButton = document.getElementsByClassName('menu-button')[0]; + const swiper = new Swiper('.swiper-container', { + slidesPerView: 'auto', + initialSlide: 1, + resistanceRatio: .00000000000001, + onSlideChangeStart: (slider) => { + if (slider.activeIndex === 0) { + menuButton.classList.add('cross'); + menuButton.removeEventListener('click', toggleMenu, false); + } else + menuButton.classList.remove('cross'); + }, + onSlideChangeEnd: (slider) => { + if (slider.activeIndex === 0) + menuButton.removeEventListener('click', toggleMenu, false); + else + menuButton.addEventListener('click', toggleMenu, false); + }, + slideToClickedSlide: true + }); } // 33-responsive-breakpoints.html function responsiveBreakpoints() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, slidesPerView: 5, @@ -494,7 +491,7 @@ function responsiveBreakpoints() { } // 34-autoheight.html function autoheight() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', paginationClickable: true, nextButton: '.swiper-button-next', @@ -504,7 +501,7 @@ function autoheight() { } // 35-effect-flip.html function effectFlip() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { pagination: '.swiper-pagination', effect: 'flip', grabCursor: true, @@ -514,7 +511,7 @@ function effectFlip() { } // 36-pagination-fraction.html function paginationFraction() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', pagination: '.swiper-pagination', @@ -523,7 +520,7 @@ function paginationFraction() { } // 37-pagination-progress.html function paginationProgress() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { nextButton: '.swiper-button-next', prevButton: '.swiper-button-prev', pagination: '.swiper-pagination', @@ -532,7 +529,7 @@ function paginationProgress() { } // 38-history.html function historyDemo() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { spaceBetween: 50, slidesPerView: 2, centeredSlides: true, @@ -547,7 +544,7 @@ function historyDemo() { } // 38-jquery-ie9-loop.html function jqueryIe9Loop() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { loop: true, pagination: '.swiper-pagination', paginationClickable: true, @@ -557,7 +554,7 @@ function jqueryIe9Loop() { } // 39-zoom.html function zoom() { - var swiper = new Swiper('.swiper-container', { + const swiper = new Swiper('.swiper-container', { zoom: true, pagination: '.swiper-pagination', nextButton: '.swiper-button-next', diff --git a/types/swiper/v2/index.d.ts b/types/swiper/v2/index.d.ts index a5a98b691f..446b104aba 100644 --- a/types/swiper/v2/index.d.ts +++ b/types/swiper/v2/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Sebastián Galiano // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - interface SwiperOptions { speed?: number; autoplay?: number; @@ -77,18 +76,18 @@ interface SwiperOptions { // Callbacks queueStartCallbacks?: boolean; queueEndCallbacks?: boolean; - onTouchStart?: (swiper: Swiper) => void; - onTouchMove?: (swiper: Swiper) => void; - onTouchEnd?: (swiper: Swiper) => void; - onSlideReset?: (swiper: Swiper) => void; - onSlideChangeStart?: (swiper: Swiper) => void; - onSlideChangeEnd?: (swiper: Swiper) => void; - onSlideClick?: (swiper: Swiper) => void; - onSlideTouch?: (swiper: Swiper) => void; - onImagesReady?: (swiper: Swiper) => void; - onMomentumBounce?: (swiper: Swiper) => void; - onResistanceBefore?: (swiper: Swiper, distance: any) => void; - onResistanceAfter?: (swiper: Swiper, distance: any) => void; + onTouchStart?(swiper: Swiper): void; + onTouchMove?(swiper: Swiper): void; + onTouchEnd?(swiper: Swiper): void; + onSlideReset?(swiper: Swiper): void; + onSlideChangeStart?(swiper: Swiper): void; + onSlideChangeEnd?(swiper: Swiper): void; + onSlideClick?(swiper: Swiper): void; + onSlideTouch?(swiper: Swiper): void; + onImagesReady?(swiper: Swiper): void; + onMomentumBounce?(swiper: Swiper): void; + onResistanceBefore?(swiper: Swiper, distance: any): void; + onResistanceAfter?(swiper: Swiper, distance: any): void; // Slides Loader loader?: { diff --git a/types/swiper/v2/swiper-tests.ts b/types/swiper/v2/swiper-tests.ts index ad1180a352..d4b0160098 100644 --- a/types/swiper/v2/swiper-tests.ts +++ b/types/swiper/v2/swiper-tests.ts @@ -1,4 +1,3 @@ - /// // @@ -7,7 +6,7 @@ // 01-default.html function defaultDemo() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', loop: true, grabCursor: true, @@ -27,7 +26,7 @@ function defaultDemo() { // 02-vertical-mode.html function verticalMode() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, mode: 'vertical' @@ -36,17 +35,17 @@ function verticalMode() { // 03-dynamic-slides.html function dynamicSlides() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true }); function randomColor() { - var colors = ('blue red green orange pink').split(' '); + const colors = ('blue red green orange pink').split(' '); return colors[Math.floor(Math.random() * colors.length)]; } - var count = 4; + let count = 4; $('.sdl-append').click(e => { e.preventDefault(); @@ -90,7 +89,7 @@ function dynamicSlides() { // 04-scroll-container.html function scrollContainer() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { scrollContainer: true, scrollbar: { container: '.swiper-scrollbar' @@ -100,7 +99,7 @@ function scrollContainer() { // 05-free-mode.html function freeMode() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, freeMode: true, @@ -110,7 +109,7 @@ function freeMode() { // 06-carousel-mode.html function carouselMode() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, slidesPerView: 3 @@ -119,7 +118,7 @@ function carouselMode() { // 07-carousel-loop.html function carouselLoop() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, slidesPerView: 3, @@ -129,20 +128,20 @@ function carouselLoop() { // 08-nested.html function nested() { - var swiperParent = new Swiper('.swiper-parent', { + const swiperParent = new Swiper('.swiper-parent', { pagination: '.pagination-parent', paginationClickable: true, slidesPerView: 3 }); - var swiperNested1 = new Swiper('.swiper-nested-1', { + const swiperNested1 = new Swiper('.swiper-nested-1', { mode: 'vertical', pagination: '.pagination-nested-1', paginationClickable: true, slidesPerView: 2 }); - var swiperNested2 = new Swiper('.swiper-nested-2', { + const swiperNested2 = new Swiper('.swiper-nested-2', { mode: 'vertical', pagination: '.pagination-nested-2', paginationClickable: true, @@ -152,14 +151,14 @@ function nested() { // 09-nested-loop.html function nestedLoop() { - var swiperParent = new Swiper('.swiper-parent', { + const swiperParent = new Swiper('.swiper-parent', { pagination: '.pagination-parent', paginationClickable: true, loop: true, slidesPerView: 3 }); - var swiperNested1 = new Swiper('.swiper-nested', { + const swiperNested1 = new Swiper('.swiper-nested', { mode: 'vertical', pagination: '.pagination-nested', paginationClickable: true, @@ -169,7 +168,7 @@ function nestedLoop() { // 10-tabs.html function tabs() { - var tabsSwiper = new Swiper('.swiper-container', { + const tabsSwiper = new Swiper('.swiper-container', { onlyExternal: true, speed: 500 }); @@ -188,7 +187,7 @@ function tabs() { // 11-tabs-feedback.html function tabsFeedback() { - var tabsSwiper = new Swiper('.swiper-container', { + const tabsSwiper = new Swiper('.swiper-container', { speed: 500, onSlideChangeStart: () => { $(".tabs .active").removeClass('active'); @@ -210,7 +209,7 @@ function tabsFeedback() { // 12-partial-display.html function partialDisplay() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, slidesPerView: 'auto' @@ -219,7 +218,7 @@ function partialDisplay() { // 13-threshold.html function threshold() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, moveStartThreshold: 100 @@ -228,7 +227,7 @@ function threshold() { // 14-different-widths.html function differentWidths() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, slidesPerView: 'auto' @@ -237,7 +236,7 @@ function differentWidths() { // 15-centered-slides.html function centeredSlides() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, centeredSlides: true, @@ -247,7 +246,7 @@ function centeredSlides() { // 16-visibility-api.html function visibilityApi() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true, centeredSlides: true, @@ -258,20 +257,19 @@ function visibilityApi() { // 17 - responsive.html function responsive() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { pagination: '.pagination', paginationClickable: true }); } - // // Scrollbar // // demo-1.html function demo1() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { scrollbar: { container: '.swiper-scrollbar', hide: false, @@ -282,7 +280,7 @@ function demo1() { // demo-2.html function demo2() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { scrollbar: { container: '.swiper-scrollbar', hide: false, @@ -293,7 +291,7 @@ function demo2() { // demo-3.html function demo3() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { scrollbar: { container: '.swiper-scrollbar', hide: true, @@ -304,7 +302,7 @@ function demo3() { // demo-4.html function demo4() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { slidesPerView: 3, scrollbar: { container: '.swiper-scrollbar', @@ -317,7 +315,7 @@ function demo4() { // demo-5.html function demo5() { - var mySwiper = new Swiper('.swiper-container', { + const mySwiper = new Swiper('.swiper-container', { scrollContainer: true, mousewheelControl: true, mode: 'vertical', @@ -327,4 +325,4 @@ function demo5() { draggable: false } }); -} \ No newline at end of file +} diff --git a/types/table/index.d.ts b/types/table/index.d.ts index b5beffb524..6bc42bacdf 100644 --- a/types/table/index.d.ts +++ b/types/table/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Evan Shortiss // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - export type borderType = 'honeywell' | 'norc' | 'ramac' | 'void'; export interface ColumnConfig { @@ -39,7 +38,7 @@ export interface TableUserConfig { columns?: { [index: number]: ColumnConfig }; - drawJoin?: (index: number, size: number) => boolean; + drawJoin?(index: number, size: number): boolean; border?: JoinStruct; columnDefault?: ColumnConfig; } diff --git a/types/tcomb/tcomb-tests.ts b/types/tcomb/tcomb-tests.ts index ab3e6ec20e..2219bb3c95 100644 --- a/types/tcomb/tcomb-tests.ts +++ b/types/tcomb/tcomb-tests.ts @@ -861,7 +861,7 @@ describe('struct', () => { }); it('should support prototypal inheritance', () => { - interface Rectangle { w: number; h: number; area(): number; }; + interface Rectangle { w: number; h: number; area(): number; } const Rectangle = struct({ w: Num, h: Num diff --git a/types/transducers-js/index.d.ts b/types/transducers-js/index.d.ts index 0ac1d18235..cfed8fbbbe 100644 --- a/types/transducers-js/index.d.ts +++ b/types/transducers-js/index.d.ts @@ -178,8 +178,8 @@ export function dropWhile(pred: (input: TInput) => boolean): Tr export class PartitionBy implements Transformer { constructor(f: (input: TInput) => any, xf: Transformer); ['@@transducer/init'](): TResult; - ['@@transducer/step'](result: TResult, input: TInput): TResult - ['@@transducer/result'](result: TResult): TResult + ['@@transducer/step'](result: TResult, input: TInput): TResult; + ['@@transducer/result'](result: TResult): TResult; } /** @@ -192,8 +192,8 @@ export function partitionBy(f: (input: TInput) => any): Transdu export class PartitionAll implements Transformer { constructor(n: number, xf: Transformer); ['@@transducer/init'](): TResult; - ['@@transducer/step'](result: TResult, input: TInput): TResult - ['@@transducer/result'](result: TResult): TResult + ['@@transducer/step'](result: TResult, input: TInput): TResult; + ['@@transducer/result'](result: TResult): TResult; } /** @@ -205,8 +205,8 @@ export function partitionAll(n: number): Transducer implements CompletingTransformer { constructor(cf: (result: TResult) => TCompleteResult, xf: Transformer); ['@@transducer/init'](): TResult; - ['@@transducer/step'](result: TResult, input: TInput): TResult - ['@@transducer/result'](result: TResult): TCompleteResult + ['@@transducer/step'](result: TResult, input: TInput): TResult; + ['@@transducer/result'](result: TResult): TCompleteResult; } /** @@ -218,8 +218,8 @@ export function completing(cf: (result: TResul export class Wrap implements Transformer { constructor(stepFn: Reducer, xf: Transformer); ['@@transducer/init'](): TResult; - ['@@transducer/step'](result: TResult, input: TInput): TResult - ['@@transducer/result'](result: TResult): TResult + ['@@transducer/step'](result: TResult, input: TInput): TResult; + ['@@transducer/result'](result: TResult): TResult; } /** diff --git a/types/transducers-js/transducers-js-tests.ts b/types/transducers-js/transducers-js-tests.ts index 30b91d8f47..634309a2b5 100644 --- a/types/transducers-js/transducers-js-tests.ts +++ b/types/transducers-js/transducers-js-tests.ts @@ -2,15 +2,12 @@ import * as t from 'transducers-js'; -const map = t.map, - filter = t.filter, - comp = t.comp, - into = t.into; +const { map, filter, comp, into } = t; // basic usage -function inc(n: number) { return n + 1; }; -function isEven(n: number) { return n % 2 === 0; }; +function inc(n: number) { return n + 1; } +function isEven(n: number) { return n % 2 === 0; } let xf = comp(map(inc), filter(isEven)); into([], xf, [0, 1, 2, 3, 4]); // [2, 4] diff --git a/types/tweezer.js/index.d.ts b/types/tweezer.js/index.d.ts index 1144eed7de..ae1f93030b 100644 --- a/types/tweezer.js/index.d.ts +++ b/types/tweezer.js/index.d.ts @@ -5,7 +5,7 @@ interface Options { duration?: number; - easing?: (currentTime: number, beginningTime: number, changeInValue: number, duration: number) => number; + easing?(currentTime: number, beginningTime: number, changeInValue: number, duration: number): number; start: number; end: number; } diff --git a/types/tweezer.js/tweezer.js-tests.ts b/types/tweezer.js/tweezer.js-tests.ts index cd3218966f..4fb7e7a05c 100644 --- a/types/tweezer.js/tweezer.js-tests.ts +++ b/types/tweezer.js/tweezer.js-tests.ts @@ -6,7 +6,7 @@ const tweezer = new Tweezer({ }); tweezer - .on('tick', (foo) => {foo.toFixed()}) + .on('tick', (foo) => { foo.toFixed(); }) .on('done', () => {}) .begin() .stop(); diff --git a/types/ui-router-extras/index.d.ts b/types/ui-router-extras/index.d.ts index 006a68b0f3..647263c912 100644 --- a/types/ui-router-extras/index.d.ts +++ b/types/ui-router-extras/index.d.ts @@ -93,8 +93,8 @@ declare module 'angular' { } /** - * Sticky state - */ + * Sticky state + */ interface IStickyState extends angular.ui.IState { /* * When marking a state sticky, the state must target its own unique named ui-view. diff --git a/types/uikit/index.d.ts b/types/uikit/index.d.ts index 11a68c1848..de14822d28 100644 --- a/types/uikit/index.d.ts +++ b/types/uikit/index.d.ts @@ -153,7 +153,7 @@ declare namespace UIkit { * Parameter * Description * - + * * * show.uk.modal * event @@ -168,15 +168,14 @@ declare namespace UIkit { * @example * 
    
      * $('.modalSelector').on({
-	 *
-	 *	'show.uk.modal': function(){
-	 *    console.log("Modal is visible.");
-	 *	},
-	 *
-	 *   'hide.uk.modal': function(){
-	 *    console.log("Element is not visible.");
-	 *  }
-	 *	});
+     *     'show.uk.modal': function(){
+     *         console.log("Modal is visible.");
+     *     },
+     *
+     *     'hide.uk.modal': function(){
+     *         console.log("Element is not visible.");
+     *     }
+     * });
      *
    */ interface Modal { @@ -227,10 +226,10 @@ declare namespace UIkit { * var modal = UIkit.modal(".modalSelector"); * * if ( modal.isActive() ) { - * modal.hide(); - * } else { - * modal.show(); - * } + * modal.hide(); + * } else { + * modal.show(); + * } * */ (selector: string|JQuery, options?: ModalOptions): ModalElement; @@ -326,7 +325,6 @@ declare namespace UIkit { * Init element manually */ (element: string|JQuery, options?: LightBoxOptions): LightBoxElement; - } type CallbackAutoComplete = () => string; interface AutoCompleteOptions { @@ -420,7 +418,6 @@ declare namespace UIkit { * @default 'auto' */ pos?: string; - } /** * Create a toggleable dropdown with an datepicker @@ -711,7 +708,6 @@ declare namespace UIkit { */ type SlideShow = (element: string|JQuery, options: SlideShowOptions) => any; interface ParallaxOptions { - /** * Animation velocity during scrolling * @default 0.5 @@ -736,7 +732,6 @@ declare namespace UIkit { * integer / string */ media?: number|string; - } /** * Animate CSS properties depending on the scroll position of the document. @@ -899,7 +894,6 @@ declare namespace UIkit { * integer */ delay?: number; - } /** * Easily create a nicely looking search. @@ -1020,7 +1014,6 @@ declare namespace UIkit { * string */ emptyClass?: string; - } /** * Create nestable lists that can be sorted by drag and drop. @@ -1091,7 +1084,6 @@ declare namespace UIkit { * string */ dragCustomClass?: string; - } /** * Create sortable grids and lists to rearrange the order of its elements. @@ -1197,7 +1189,6 @@ declare namespace UIkit { * mixed */ boundary?: boolean|string; - } /** * Make elements remain at the top of the viewport, like a sticky navbar. @@ -1244,7 +1235,6 @@ declare namespace UIkit { * Integer between 0 and 24 */ end?: number; - } /** * Create a timepicker which can easily be used by selecting a time value from a pre filled dropdown. @@ -1294,7 +1284,6 @@ declare namespace UIkit { * string */ activeClass?: string; - } /** * Easily create a nicely looking tooltip. @@ -1351,19 +1340,19 @@ declare namespace UIkit { * (text|json) */ "type"?: string; - before?: (settings: UploadOptions, files: string|string[]) => any; - beforeAll?: (files: string|string[]) => any; - beforeSend?: (xhr: XMLHttpRequest) => any; - progress?: (percent: number) => any; - complete?: (response: any, xhr: XMLHttpRequest) => any; - allcomplete?: (response: any, xhr: XMLHttpRequest) => any; - notallowed?: (file: string|string[], settings: UploadOptions) => any; - loadstart?: (event: any) => any; - load?: (event: any) => any; - loadend?: (event: any) => any; - error?: (event: any) => any; - abort?: (event: any) => any; - readystatechange?: (event: any) => any; + before?(settings: UploadOptions, files: string|string[]): any; + beforeAll?(files: string|string[]): any; + beforeSend?(xhr: XMLHttpRequest): any; + progress?(percent: number): any; + complete?(response: any, xhr: XMLHttpRequest): any; + allcomplete?(response: any, xhr: XMLHttpRequest): any; + notallowed?(file: string|string[], settings: UploadOptions): any; + loadstart?(event: any): any; + load?(event: any): any; + loadend?(event: any): any; + error?(event: any): any; + abort?(event: any): any; + readystatechange?(event: any): any; } /** @@ -1430,25 +1419,25 @@ declare namespace UIkit { * */ type Upload = (element: string|JQuery, options: UploadOptions) => any; - var dropdown: Dropdown; - var modal: Modal; - var lightbox: LightBox; - var offcanvas: OffCanvas; - var autocomplete: AutoComplete; - var datepicker: DatePicker; - var htmleditor: HtmlEditor; - var slider: Slider; - var slideset: SlideSet; - var slideshow: SlideShow; - var parallax: Parallax; - var accordion: Accordion; - var notify: Notify; - var search: Search; - var nestable: Nestable; - var sortable: Sortable; - var sticky: Sticky; - var timepicker: Timepicker; - var tooltip: Tooltip; - var uploadSelect: Upload; - var uploadDrop: Upload; + const dropdown: Dropdown; + const modal: Modal; + const lightbox: LightBox; + const offcanvas: OffCanvas; + const autocomplete: AutoComplete; + const datepicker: DatePicker; + const htmleditor: HtmlEditor; + const slider: Slider; + const slideset: SlideSet; + const slideshow: SlideShow; + const parallax: Parallax; + const accordion: Accordion; + const notify: Notify; + const search: Search; + const nestable: Nestable; + const sortable: Sortable; + const sticky: Sticky; + const timepicker: Timepicker; + const tooltip: Tooltip; + const uploadSelect: Upload; + const uploadDrop: Upload; } diff --git a/types/uikit/uikit-tests.ts b/types/uikit/uikit-tests.ts index 5a28b61682..a33780085e 100644 --- a/types/uikit/uikit-tests.ts +++ b/types/uikit/uikit-tests.ts @@ -13,7 +13,7 @@ function testDropdown() { hoverDelayIdle: 200, preventflip: 'x' }; - var dropdown = UIkit.dropdown("$parent", options); + const dropdown = UIkit.dropdown("$parent", options); dropdown.show(); dropdown.hide(); @@ -40,10 +40,10 @@ function testModal() { UIkit.modal.prompt("Name:", 'value', (newvalue: string) => { // will be executed on submit. }); - var modal = UIkit.modal.blockUI("Any content..."); + let modal = UIkit.modal.blockUI("Any content..."); modal.hide(); modal.show(); - var modal = UIkit.modal(".modalSelector"); + modal = UIkit.modal(".modalSelector"); if (modal.isActive()) { modal.hide(); @@ -59,14 +59,14 @@ function testOffCanvas() { } function testLightBox() { - var element = "#group"; - var lightbox = UIkit.lightbox(element, {/* options */}); - var lightbox2 = UIkit.lightbox.create([ + const element = "#group"; + const lightbox = UIkit.lightbox(element, {/* options */}); + const lightbox2 = UIkit.lightbox.create([ {source: 'http://url/to/video.mp4', type: 'video'}, {source: 'http://url/to/image.jpg', type: 'image'} ]); lightbox2.show(); - var lightbox3 = UIkit.lightbox(element); + const lightbox3 = UIkit.lightbox(element); } function testAutoComplete() { @@ -75,31 +75,30 @@ function testAutoComplete() { } function testDatepicker() { - var datepicker = UIkit.datepicker("#element", {}); + const datepicker = UIkit.datepicker("#element", {}); } function testHtmlEditor() { - var htmleditor = UIkit.htmleditor("textarea", {/* options */}); + const htmleditor = UIkit.htmleditor("textarea", {/* options */}); } function testSlider() { - var slider = UIkit.slider("element", {}); + const slider = UIkit.slider("element", {}); } function testSlideSet() { - var slideset = UIkit.slideset("element", {}); + const slideset = UIkit.slideset("element", {}); } function testSlideShow() { - var slideshow = UIkit.slideshow("element", {}); + const slideshow = UIkit.slideshow("element", {}); } function testParallax() { - var parallax = UIkit.parallax("element", {}); + const parallax = UIkit.parallax("element", {}); } function testAccordion() { - var accordion = UIkit.accordion("element", {}); + const accordion = UIkit.accordion("element", {}); } - function testNotify() { UIkit.notify({ message: 'Bazinga!', @@ -108,8 +107,7 @@ function testNotify() { pos: 'top-center' }); - -// Shortcuts + // Shortcuts UIkit.notify('My message'); UIkit.notify('My message', status); UIkit.notify('My message', {/* options */}); @@ -119,100 +117,70 @@ function testNotify() { UIkit.notify("...", {status: 'info'}); } - function testSearch() { - var search = UIkit.search("element", {}); + const search = UIkit.search("element", {}); } function testNestable() { - var nestable = UIkit.nestable('element', {}); + const nestable = UIkit.nestable('element', {}); } function testSortable() { - var sortable = UIkit.sortable('element', {}); + const sortable = UIkit.sortable('element', {}); } function testStick() { - var sticky = UIkit.sticky('element', {}); + const sticky = UIkit.sticky('element', {}); } function testTimePicker() { - var timepicker = UIkit.timepicker('element', {}); + const timepicker = UIkit.timepicker('element', {}); } function testTooltip() { - var tooltip = UIkit.tooltip('element', {}); + const tooltip = UIkit.tooltip('element', {}); } function testUpload() { $(() => { + const progressbar = $("#progressbar"); + const bar = progressbar.find('.uk-progress-bar'); + const settings = { + action: '/', // upload url + allow : '*.(jpg|jpeg|gif|png)', // allow only images + loadstart() { + bar.css("width", "0%").text("0%"); + progressbar.removeClass("uk-hidden"); + }, + progress(percent: number) { + percent = Math.ceil(percent); + bar.css("width", percent + "%").text(percent + "%"); + }, + allcomplete(response: any) { + bar.css("width", "100%").text("100%"); - var progressbar = $("#progressbar"), - bar = progressbar.find('.uk-progress-bar'), - settings = { + setTimeout(() => { + progressbar.addClass("uk-hidden"); + }, 250); - action: '/', // upload url + alert("Upload Completed"); + } + }; - allow : '*.(jpg|jpeg|gif|png)', // allow only images - - loadstart() { - bar.css("width", "0%").text("0%"); - progressbar.removeClass("uk-hidden"); - }, - - progress(percent: number) { - percent = Math.ceil(percent); - bar.css("width", percent + "%").text(percent + "%"); - }, - - allcomplete(response: any) { - - bar.css("width", "100%").text("100%"); - - setTimeout(() => { - progressbar.addClass("uk-hidden"); - }, 250); - - alert("Upload Completed"); - } - }; - - var select = UIkit.uploadSelect($("#upload-select"), settings), - drop = UIkit.uploadDrop($("#upload-drop"), settings); + const select = UIkit.uploadSelect($("#upload-select"), settings); + const drop = UIkit.uploadDrop($("#upload-drop"), settings); }); // Test with object literal - var select2 = UIkit.uploadSelect($("#upload-select"), { - + const select2 = UIkit.uploadSelect($("#upload-select"), { action: '/', // upload url - allow: '*.(jpg|jpeg|gif|png)', // allow only images - - loadstart: () => { - - }, - - progress: (percent: number) => { - - }, - - allcomplete: (response: any) => { - - } + loadstart: () => {}, + progress: (percent: number) => {}, + allcomplete: (response: any) => {} }); - var drop2 = UIkit.uploadDrop($("#upload-drop"), { - + const drop2 = UIkit.uploadDrop($("#upload-drop"), { action: '/', // upload url - allow: '*.(jpg|jpeg|gif|png)', // allow only images - - loadstart: () => { - - }, - - progress: (percent: number) => { - - }, - - allcomplete: (response: any) => { - } + loadstart: () => {}, + progress: (percent: number) => {}, + allcomplete: (response: any) => {} }); - } diff --git a/types/update-notifier/index.d.ts b/types/update-notifier/index.d.ts index d9d6c8a4cc..625f93f591 100644 --- a/types/update-notifier/index.d.ts +++ b/types/update-notifier/index.d.ts @@ -19,7 +19,7 @@ declare namespace UpdateNotifier { interface Settings { pkg?: Package; - callback?: (update?: UpdateInfo) => any; + callback?(update?: UpdateInfo): any; packageName?: string; packageVersion?: string; updateCheckInterval?: number; // in milliseconds, default 1000 * 60 * 60 * 24 (1 day) diff --git a/types/update-notifier/update-notifier-tests.ts b/types/update-notifier/update-notifier-tests.ts index a39ead18ea..49f16a3dc3 100644 --- a/types/update-notifier/update-notifier-tests.ts +++ b/types/update-notifier/update-notifier-tests.ts @@ -1,6 +1,6 @@ import UpdateNotifier = require("update-notifier"); -var notifier = UpdateNotifier(); +let notifier = UpdateNotifier(); if (notifier.update) { notifier.notify(); @@ -9,7 +9,7 @@ if (notifier.update) { console.log(notifier.update); // Also exposed as a class -var notifier = new UpdateNotifier.UpdateNotifier({ +notifier = new UpdateNotifier.UpdateNotifier({ updateCheckInterval: 1000 * 60 * 60 * 24 * 7 // 1 week }); diff --git a/types/user-home/user-home-tests.ts b/types/user-home/user-home-tests.ts index 056a31095e..fa08b6fe49 100644 --- a/types/user-home/user-home-tests.ts +++ b/types/user-home/user-home-tests.ts @@ -1,4 +1,4 @@ import userHome = require('user-home'); console.log(userHome); -// => '/Users/sindresorhus' \ No newline at end of file +// => '/Users/sindresorhus' diff --git a/types/uuid-js/uuid-js-tests.ts b/types/uuid-js/uuid-js-tests.ts index 67ef73ba68..6662bb6cd8 100644 --- a/types/uuid-js/uuid-js-tests.ts +++ b/types/uuid-js/uuid-js-tests.ts @@ -1,28 +1,24 @@ import UUID = require('uuid-js'); - // Generate a V4 UUID -var uuid4 = UUID.create(); +const uuid4 = UUID.create(); console.log(uuid4.toString()); // Prints: 896b677f-fb14-11e0-b14d-d11ca798dbac - // Generate a V1 TimeUUID -var uuid1 = UUID.create(1); +const uuid1 = UUID.create(1); console.log(uuid1.toString()); - // First and last possible v1 TimeUUID for a given timestamp: -var date = new Date().getTime(); -var uuidFirst = UUID.fromTime(date, false); -var uuidLast = UUID.fromTime(date, true); +const date = new Date().getTime(); +const uuidFirst = UUID.fromTime(date, false); +const uuidLast = UUID.fromTime(date, true); console.log(uuidFirst.toString(), uuidLast.toString()); // Prints: aa0f9af0-0e1f-11e1-0000-000000000000 aa0f9af0-0e1f-11e1-c0ff-ffffffffffff - // Use these TimeUUID's to perform range queries in cassandra: -var today = new Date().getTime(); -var last30days = (new Date().setDate(today - 30)); +const today = new Date().getTime(); +const last30days = (new Date().setDate(today - 30)); -var rangeStart = UUID.firstFromTime(last30days); -var rangeEnd = UUID.lastFromTime(today); +const rangeStart = UUID.firstFromTime(last30days); +const rangeEnd = UUID.lastFromTime(today); diff --git a/types/verror/index.d.ts b/types/verror/index.d.ts index 78bd4920f6..b8a14ae425 100644 --- a/types/verror/index.d.ts +++ b/types/verror/index.d.ts @@ -39,7 +39,7 @@ declare namespace VError { cause?: Error | null | undefined; name?: string; strict?: boolean; - constructorOpt?: (...args: any[]) => void; + constructorOpt?(...args: any[]): void; info?: Info; } diff --git a/types/verror/verror-tests.ts b/types/verror/verror-tests.ts index 8a243d2fab..efb52c9178 100644 --- a/types/verror/verror-tests.ts +++ b/types/verror/verror-tests.ts @@ -1,14 +1,14 @@ import VError = require("verror"); import { VError as VError2, MultiError, SError, WError } from "verror"; -var error = new Error("foo"); -var verror1 = new VError(error, "bar"); -var verror2 = new VError2(error, "bar"); -var serror = new SError(error, "bar"); -var multiError = new MultiError([verror1, verror2]); -var werror = new WError(verror1, "foobar"); +const error = new Error("foo"); +const verror1 = new VError(error, "bar"); +const verror2 = new VError2(error, "bar"); +const serror = new SError(error, "bar"); +const multiError = new MultiError([verror1, verror2]); +const werror = new WError(verror1, "foobar"); -var verror3 = new VError({ +const verror3 = new VError({ name: "fooError", cause: error, info: { @@ -16,13 +16,12 @@ var verror3 = new VError({ } }, "bar"); -var verror4 = new VError({ cause: null }, "bar"); +const verror4 = new VError({ cause: null }, "bar"); -var cause1: Error | undefined = verror1.cause(); -var cause2: Error | undefined = werror.cause(); +const cause1: Error | undefined = verror1.cause(); +const cause2: Error | undefined = werror.cause(); const info: { [k: string]: any } = VError.info(verror3); const namedCause: Error | null = VError.findCauseByName(verror3, "fooError"); const stack: string = VError.fullStack(verror3); const cause3: Error | null = VError.cause(verror3); - diff --git a/types/videojs/index.d.ts b/types/videojs/index.d.ts index 5b894b0912..892390094d 100644 --- a/types/videojs/index.d.ts +++ b/types/videojs/index.d.ts @@ -12,7 +12,6 @@ export = videojs; export as namespace videojs; declare namespace videojs { - interface PlayerOptions { techOrder?: string[]; html5?: any; diff --git a/types/videojs/videojs-tests.ts b/types/videojs/videojs-tests.ts index 6f9907ea1c..b3140e8ea7 100644 --- a/types/videojs/videojs-tests.ts +++ b/types/videojs/videojs-tests.ts @@ -8,8 +8,8 @@ videojs("example_video_1").ready(function() { this.pause(); - var isPaused: boolean = this.paused(); - var isPlaying: boolean = !this.paused(); + const isPaused: boolean = this.paused(); + const isPlaying: boolean = !this.paused(); this.src("http://www.example.com/path/to/video.mp4"); @@ -21,37 +21,37 @@ videojs("example_video_1").ready(function() { { type: "video/ogg", src: "http://www.example.com/path/to/video.ogv" } ]); - var whereYouAt: number = this.currentTime(); + const whereYouAt: number = this.currentTime(); this.currentTime(120); // 2 minutes into the video - var howLongIsThis: number = this.duration(); + const howLongIsThis: number = this.duration(); - var bufferedTimeRange: TimeRanges = this.buffered(); + const bufferedTimeRange: TimeRanges = this.buffered(); // Number of different ranges of time have been buffered. Usually 1. - var numberOfRanges: number = bufferedTimeRange.length; + const numberOfRanges: number = bufferedTimeRange.length; // Time in seconds when the first range starts. Usually 0. - var firstRangeStart: number = bufferedTimeRange.start(0); + const firstRangeStart: number = bufferedTimeRange.start(0); // Time in seconds when the first range ends - var firstRangeEnd: number = bufferedTimeRange.end(0); + const firstRangeEnd: number = bufferedTimeRange.end(0); // Length in seconds of the first time range - var firstRangeLength: number = firstRangeEnd - firstRangeStart; + const firstRangeLength: number = firstRangeEnd - firstRangeStart; - var howMuchIsDownloaded: number = this.bufferedPercent(); + const howMuchIsDownloaded: number = this.bufferedPercent(); - var howLoudIsIt: number = this.volume(); + const howLoudIsIt: number = this.volume(); this.volume(0.5); // Set volume to half - var howWideIsIt: number = this.width(); + const howWideIsIt: number = this.width(); this.width(640); - var howTallIsIt: number = this.height(); + const howTallIsIt: number = this.height(); this.height(480); @@ -70,7 +70,6 @@ function testEvents(myPlayer: videojs.Player) { // Removes the specified listener only. myPlayer.off("error", myFunc); - const myFuncWithArg = function(this: videojs.Player, e: Event) { // Do something when the event is fired }; diff --git a/types/vinyl-fs/index.d.ts b/types/vinyl-fs/index.d.ts index 84bcaf3533..46510032ee 100644 --- a/types/vinyl-fs/index.d.ts +++ b/types/vinyl-fs/index.d.ts @@ -25,17 +25,17 @@ interface SrcOptions extends globStream.Options { cwd?: string; /** - * Specifies the folder relative to the cwd - * This is used to determine the file names when saving in .dest() - * Default: where the glob begins - */ + * Specifies the folder relative to the cwd + * This is used to determine the file names when saving in .dest() + * Default: where the glob begins + */ base?: string; /** - * Setting this to false will make file.contents a paused stream - * If true it will buffer the file contents - * Default: true - */ + * Setting this to false will make file.contents a paused stream + * If true it will buffer the file contents + * Default: true + */ buffer?: boolean; /** @@ -59,10 +59,10 @@ interface SrcOptions extends globStream.Options { followSymlinks?: boolean; /** - * Setting this to false will ignore the contents of the file and disable - * writing to disk to speed up operations - * Default: true - */ + * Setting this to false will ignore the contents of the file and disable + * writing to disk to speed up operations + * Default: true + */ read?: boolean; /** @@ -95,30 +95,30 @@ interface SrcOptions extends globStream.Options { } /** -* Gets files that match the glob and converts them into the vinyl format -* @param globs Takes a glob string or an array of glob strings as the first argument -* Globs are executed in order, so negations should follow positive globs -* fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) -* @param opt Options Vinyl source options, changes the way the files are read, found, or stored in the vinyl stream -*/ + * Gets files that match the glob and converts them into the vinyl format + * @param globs Takes a glob string or an array of glob strings as the first argument + * Globs are executed in order, so negations should follow positive globs + * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) + * @param opt Options Vinyl source options, changes the way the files are read, found, or stored in the vinyl stream + */ export function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream; /** -* This is just a glob-watcher -* -* @param globs Takes a glob string or an array of glob strings as the first argument -* Globs are executed in order, so negations should follow positive globs -* fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) -*/ + * This is just a glob-watcher + * + * @param globs Takes a glob string or an array of glob strings as the first argument + * Globs are executed in order, so negations should follow positive globs + * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) + */ export function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; /** -* This is just a glob-watcher -* -* @param globs Takes a glob string or an array of glob strings as the first argument -* Globs are executed in order, so negations should follow positive globs -* fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) -*/ + * This is just a glob-watcher + * + * @param globs Takes a glob string or an array of glob strings as the first argument + * Globs are executed in order, so negations should follow positive globs + * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) + */ export function watch( globs: string|string[], opt?: { @@ -130,24 +130,24 @@ export function watch( cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; /** -* On write the stream will save the vinyl File to disk at the folder/cwd specified. -* After writing the file to disk, it will be emitted from the stream so you can keep piping these around. -* The file will be modified after being written to this stream: -* cwd, base, and path will be overwritten to match the folder -* stat.mode will be overwritten if you used a mode parameter -* contents will have it's position reset to the beginning if it is a stream -* @param folder destination folder -*/ + * On write the stream will save the vinyl File to disk at the folder/cwd specified. + * After writing the file to disk, it will be emitted from the stream so you can keep piping these around. + * The file will be modified after being written to this stream: + * cwd, base, and path will be overwritten to match the folder + * stat.mode will be overwritten if you used a mode parameter + * contents will have it's position reset to the beginning if it is a stream + * @param folder destination folder + */ export function dest(folder: string, opt?: { /** Specify the working directory the folder is relative to - * Default is process.cwd() - */ + * Default is process.cwd() + */ cwd?: string; /** Specify the mode the files should be created with - * Default is the mode of the input file (file.stat.mode) - * or the process mode if the input file has no mode property - */ + * Default is the mode of the input file (file.stat.mode) + * or the process mode if the input file has no mode property + */ mode?: number|string; /** Specify the mode the directory should be created with. Default is the process mode */ @@ -158,56 +158,56 @@ export function dest(folder: string, opt?: { }): NodeJS.ReadWriteStream; /** -* On write the stream will save the vinyl File to disk at the folder/cwd specified. -* After writing the file to disk, it will be emitted from the stream so you can keep piping these around. -* The file will be modified after being written to this stream: -* cwd, base, and path will be overwritten to match the folder -* stat.mode will be overwritten if you used a mode parameter -* contents will have it's position reset to the beginning if it is a stream -* @param getFolderPath function that takes in a file and returns a folder path -*/ + * On write the stream will save the vinyl File to disk at the folder/cwd specified. + * After writing the file to disk, it will be emitted from the stream so you can keep piping these around. + * The file will be modified after being written to this stream: + * cwd, base, and path will be overwritten to match the folder + * stat.mode will be overwritten if you used a mode parameter + * contents will have it's position reset to the beginning if it is a stream + * @param getFolderPath function that takes in a file and returns a folder path + */ export function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; /** -* On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd specified. -* After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. -* The file will be modified after being written to this stream: -* cwd, base, and path will be overwritten to match the folder -*/ + * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd specified. + * After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. + * The file will be modified after being written to this stream: + * cwd, base, and path will be overwritten to match the folder + */ export function symlink(folder: string, opts?: { /** - * Specify the working directory the folder is relative to - * Default is process.cwd() - */ + * Specify the working directory the folder is relative to + * Default is process.cwd() + */ cwd?: string; /** Specify the mode the directory should be created with. Default is the process mode */ mode?: number|string; /** - * Specify the mode the directory should be created with - * Default is the process mode - */ + * Specify the mode the directory should be created with + * Default is the process mode + */ dirMode?: number }): NodeJS.ReadWriteStream; /** -* On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd generated from getFolderPath. -* After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. -* The file will be modified after being written to this stream: -* cwd, base, and path will be overwritten to match the folder -*/ + * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd generated from getFolderPath. + * After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. + * The file will be modified after being written to this stream: + * cwd, base, and path will be overwritten to match the folder + */ export function symlink(getFolderPath: (File: File) => string, opts?: { /** - * Specify the working directory the folder is relative to - * Default is process.cwd() - */ + * Specify the working directory the folder is relative to + * Default is process.cwd() + */ cwd?: string; /** - * Specify the mode the directory should be created with - * Default is the process mode - */ + * Specify the mode the directory should be created with + * Default is the process mode + */ dirMode?: number }): NodeJS.ReadWriteStream; diff --git a/types/vis/index.d.ts b/types/vis/index.d.ts index 0d94a44354..3b94d694f9 100644 --- a/types/vis/index.d.ts +++ b/types/vis/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for vis.js 4.17 +// Type definitions for vis.js 4.18 // Project: https://github.com/almende/vis // Definitions by: Michaël Bitard // MacLeod Broad @@ -71,7 +71,6 @@ interface PointItem extends DataItem { y: number; } - interface DataGroup { className?: string; content: string; @@ -154,14 +153,14 @@ interface TimelineOptions { groupEditable?: TimelineOptionsGroupEditableType; groupOrder?: TimelineOptionsGroupOrderType; groupOrderSwap?: TimelineOptionsGroupOrderSwapFunction; - groupTemplate?: () => void; // TODO + groupTemplate?(): void; // TODO height?: HeightWidthType; hiddenDates?: any; // TODO horizontalScroll?: boolean; itemsAlwaysDraggable?: boolean; locale?: string; locales?: any; // TODO - moment?: () => void; // TODO + moment?(): void; // TODO margin?: TimelineOptionsMarginType; max?: DateType; maxHeight?: HeightWidthType; @@ -171,17 +170,17 @@ interface TimelineOptions { moveable?: boolean; multiselect?: boolean; multiselectPerGroup?: boolean; - onAdd?: () => void; // TODO - onAddGroup?: () => void; // TODO - onUpdate?: () => void; // TODO - onMove?: () => void; // TODO - onMoveGroup?: () => void; // TODO - onMoving?: () => void; // TODO - onRemove?: () => void; // TODO - onRemoveGroup?: () => void; // TODO - order?: () => void; // TODO + onAdd?(): void; // TODO + onAddGroup?(): void; // TODO + onUpdate?(): void; // TODO + onMove?(): void; // TODO + onMoveGroup?(): void; // TODO + onMoving?(): void; // TODO + onRemove?(): void; // TODO + onRemoveGroup?(): void; // TODO + order?(): void; // TODO orientation?: TimelineOptionsOrientationType; - rollingMode: boolean; + rollingMode?: boolean; selectable?: boolean; showCurrentTime?: boolean; showMajorLabels?: boolean; @@ -189,11 +188,11 @@ interface TimelineOptions { stack?: boolean; snap?: TimelineOptionsSnapFunction; start?: DateType; - template?: () => void; // TODO + template?(): void; // TODO throttleRedraw?: number; timeAxis?: TimelineTimeAxisOption; type?: string; - tooltipOnItemUpdateTime?: boolean | { template: (item: any) => any }; + tooltipOnItemUpdateTime?: boolean | { template(item: any): any }; verticalScroll?: boolean; width?: HeightWidthType; zoomable?: boolean; @@ -276,7 +275,6 @@ interface DataSetQueueOptions { } export class DataSet { - /** * Creates an instance of DataSet. * @@ -539,7 +537,7 @@ interface DataSelectionOptions { * * @memberOf DataSelectionOptions */ - filter?: (item: T) => boolean; + filter?(item: T): boolean; /** * Order the items by a field name or custom sort function. @@ -581,7 +579,7 @@ interface RangeType { interface DataAxisSideOption { range?: RangeType; - format?: () => string; + format?(): string; title?: TitleOption; } @@ -611,7 +609,7 @@ interface Graph2dDataAxisOption { interface Graph2dDrawPointsOption { enabled?: boolean; - onRender?: () => boolean; // TODO + onRender?(): boolean; // TODO size?: number; style: Graph2dDrawPointsStyle; } @@ -642,7 +640,7 @@ interface Graph2dOptions { legend?: Graph2dLegendOption; locale?: string; locales?: any; // TODO - moment?: () => void; // TODO + moment?(): void; // TODO max?: DateType; maxHeight?: HeightWidthType; maxMinorChars?: number; @@ -840,7 +838,6 @@ type NetworkEvents = * @implements {INetwork} */ export class Network { - /** * Creates an instance of Network. * @@ -1476,12 +1473,12 @@ export interface ViewPortOptions { offset?: Position; /** - * For animation you can either use a Boolean to use it with the default options or - * disable it or you can define the duration (in milliseconds) and easing function manually. - * - * @type {(IAnimationOptions | boolean)} - * @memberOf IFitOptions - */ + * For animation you can either use a Boolean to use it with the default options or + * disable it or you can define the duration (in milliseconds) and easing function manually. + * + * @type {(IAnimationOptions | boolean)} + * @memberOf IFitOptions + */ animation?: AnimationOptions | boolean; } @@ -1510,7 +1507,6 @@ export interface MoveToOptions extends ViewPortOptions { * @interface IAnimationOptions */ export interface AnimationOptions { - /** * The duration (in milliseconds). * @@ -1539,7 +1535,6 @@ export interface AnimationOptions { * @interface IFitOptions */ export interface FitOptions { - /** * The nodes can be used to zoom to fit only specific nodes in the view. * @@ -1583,7 +1578,6 @@ export interface BoundingBox { * @interface IClusterOptions */ export interface ClusterOptions { - /** * Optional for all but the cluster method. * The cluster module loops over all nodes that are selected to be in the cluster @@ -1593,7 +1587,7 @@ export interface ClusterOptions { * * @memberOf IClusterOptions */ - joinCondition?: (nodeOptions: any) => boolean; + joinCondition?(nodeOptions: any): boolean; /** * Optional. @@ -1605,7 +1599,7 @@ export interface ClusterOptions { * @type {(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[])} * @memberOf IClusterOptions */ - processProperties?: (clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[]) => any; + processProperties?(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[]): any; /** * Optional. @@ -1641,7 +1635,6 @@ export interface ClusterOptions { * @interface IOpenClusterOptions */ export interface OpenClusterOptions { - /** * A function that can be used to manually position the nodes after the cluster is opened. * The containedNodesPositions contain the positions of the nodes in the cluster at the @@ -1656,9 +1649,9 @@ export interface OpenClusterOptions { * * @memberOf IOpenClusterOptions */ - releaseFunction: ( + releaseFunction( clusterPosition: Position, - containedNodesPositions: { [nodeId: string]: Position }) => { [nodeId: string]: Position }; + containedNodesPositions: { [nodeId: string]: Position }): { [nodeId: string]: Position }; } export interface Position { @@ -1667,7 +1660,6 @@ export interface Position { } export interface Properties { - nodes: string[]; edges: string[]; @@ -1686,7 +1678,7 @@ export interface Properties { } export interface Callback { - callback?: (params?: any) => void; + callback?(params?: any): void; } export interface Data { diff --git a/types/vis/vis-tests.ts b/types/vis/vis-tests.ts index 2b3b28fb7b..354f766cb0 100644 --- a/types/vis/vis-tests.ts +++ b/types/vis/vis-tests.ts @@ -21,8 +21,8 @@ interface TestData { } // create a DataSet -var options = {}; -var data = new vis.DataSet(options); +let options = {}; +let data = new vis.DataSet(options); // add items // note that the data items can contain different properties and data formats @@ -45,15 +45,15 @@ data.update({ id: 2, group: 1 }); data.remove(4); // get all ids -var ids = data.getIds(); +const ids = data.getIds(); console.log('ids', ids); // get a specific item -var item1 = data.get(1); +const item1 = data.get(1); console.log('item1', item1); // retrieve a filtered subset of the data -var items = data.get({ +let items = data.get({ filter: (item) => { return item.group === 1; } @@ -61,7 +61,7 @@ var items = data.get({ console.log('filtered items', items); // retrieve formatted items -var items = data.get({ +items = data.get({ fields: ['id', 'date'], type: { date: 'ISODate' @@ -74,7 +74,7 @@ console.log('formatted items', items); // // create a DataSet -var data = new vis.DataSet(); +data = new vis.DataSet(); // subscribe to any change in the DataSet data.on('*', (event, properties, senderId) => { @@ -91,7 +91,7 @@ data.remove(1); // triggers an 'remove' event // // create a DataSet -var data = new vis.DataSet(); +data = new vis.DataSet(); // add items data.add([ @@ -111,7 +111,7 @@ data.remove(3); // // create a DataSet -var data = new vis.DataSet(); +data = new vis.DataSet(); data.add([ { id: 1, text: 'item 1', date: '2013-06-20', group: 1, first: true }, { id: 2, text: 'item 2', date: '2013-06-23', group: 2 }, @@ -120,7 +120,7 @@ data.add([ ]); // retrieve formatted items -var items = data.get({ +items = data.get({ fields: ['id', 'date', 'group'], // output the specified fields only type: { date: 'Date', // convert the date fields to Date objects @@ -128,19 +128,19 @@ var items = data.get({ } }); -var dataset = new vis.DataSet(); +const dataset = new vis.DataSet(); // retrieve all items having a property group with value 2 -var group2 = dataset.get({ +const group2 = dataset.get({ filter: (item) => { return (item.group === 2); } }); // retrieve all items having a property balance with a value above zero -var positiveBalance = dataset.get({ +const positiveBalance = dataset.get({ filter: (item) => { - return (item.balance > 0); + return item.balance !== undefined && item.balance > 0; } }); @@ -149,7 +149,7 @@ var positiveBalance = dataset.get({ // // create an array with nodes -var nodes = new vis.DataSet([ +const nodes = new vis.DataSet([ { id: 1, label: 'Node 1' }, { id: 2, label: 'Node 2' }, { id: 3, label: 'Node 3' }, @@ -158,7 +158,7 @@ var nodes = new vis.DataSet([ ]); // create an array with edges -var edges = new vis.DataSet([ +const edges = new vis.DataSet([ { from: 1, to: 3 }, { from: 1, to: 2 }, { from: 2, to: 4 }, @@ -166,21 +166,21 @@ var edges = new vis.DataSet([ ]); // create a network -var container = document.getElementById('mynetwork'); +const container = document.getElementById('mynetwork'); // provide the data in the vis format -var data2 = { nodes, edges }; -var options = {}; +const data2 = { nodes, edges }; +options = {}; // initialize your network! -var network = new vis.Network(container, data2, options); +const network = new vis.Network(container, data2, options); // // Test code sample from http://visjs.org/docs/network/configure.html# // // these are all options in full. -var options2 = { +const options2 = { configure: { enabled: true, filter: 'nodes,edges', @@ -189,4 +189,4 @@ var options2 = { } }; -network.setOptions(options2); \ No newline at end of file +network.setOptions(options2); diff --git a/types/vkbeautify/index.d.ts b/types/vkbeautify/index.d.ts index 259fc3e058..292f0ce4e7 100644 --- a/types/vkbeautify/index.d.ts +++ b/types/vkbeautify/index.d.ts @@ -42,4 +42,4 @@ export function cssmin(text: string, preserveComments?: boolean): string; /** * Minifiy an sql string */ -export function sqlmin(text: string): string; \ No newline at end of file +export function sqlmin(text: string): string; diff --git a/types/vkbeautify/vkbeautify-tests.ts b/types/vkbeautify/vkbeautify-tests.ts index a7fd0c4839..4e506049e2 100644 --- a/types/vkbeautify/vkbeautify-tests.ts +++ b/types/vkbeautify/vkbeautify-tests.ts @@ -68,7 +68,6 @@ function sqlWithStringPattern() { VKBeautify.sql(exampleContent, ' '); } - /* * Minifying * @@ -116,4 +115,4 @@ function cssminAndRemoveComments() { // sql function sqlmin() { VKBeautify.sqlmin(exampleContent); -} \ No newline at end of file +} diff --git a/types/web-animations-js/index.d.ts b/types/web-animations-js/index.d.ts index e0124cefd3..cb2222ce20 100644 --- a/types/web-animations-js/index.d.ts +++ b/types/web-animations-js/index.d.ts @@ -3,9 +3,9 @@ // Definitions by: Kristian Moerch // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare type AnimationEffectTimingFillMode = "none" | "forwards" | "backwards" | "both" | "auto"; -declare type AnimationEffectTimingPlaybackDirection = "normal" | "reverse" | "alternate" | "alternate-reverse"; -declare type AnimationPlayState = "idle" | "pending" | "running" | "paused" | "finished"; +type AnimationEffectTimingFillMode = "none" | "forwards" | "backwards" | "both" | "auto"; +type AnimationEffectTimingPlaybackDirection = "normal" | "reverse" | "alternate" | "alternate-reverse"; +type AnimationPlayState = "idle" | "pending" | "running" | "paused" | "finished"; declare class AnimationPlaybackEvent { constructor(target: Animation, currentTime: number, timelineTime: number); @@ -53,9 +53,7 @@ declare class KeyframeEffect { getFrames(): AnimationKeyFrame[]; remove(): void; } -interface AnimationEventListener { - (evt: AnimationPlaybackEvent): void; -} +type AnimationEventListener = (evt: AnimationPlaybackEvent) => void; declare class Animation { constructor(effect: KeyframeEffect, timeline?: AnimationTimeline); diff --git a/types/web-animations-js/web-animations-js-tests.ts b/types/web-animations-js/web-animations-js-tests.ts index d27a922a98..263c117353 100644 --- a/types/web-animations-js/web-animations-js-tests.ts +++ b/types/web-animations-js/web-animations-js-tests.ts @@ -33,7 +33,7 @@ function test_AnimationsApiNext() { 'scale(0)'; const steps = [ { visibility: 'visible', opacity: 1, transform: 'none' }, - { visibility: 'visible', opacity: 0, transform: transform } + { visibility: 'visible', opacity: 0, transform } ]; return new KeyframeEffect(target, steps, { duration: 1500, @@ -64,9 +64,9 @@ function test_AnimationsApiNext() { // https://developer.mozilla.org/en-US/docs/Web/API/Animation/Animation // http://codepen.io/rachelnabors/pen/eJyWzm/?editors=0010 function test_whiteRabbit() { - var whiteRabbit = document.getElementById("rabbit"); + const whiteRabbit = document.getElementById("rabbit"); if (whiteRabbit) { - var rabbitDownKeyframes = new KeyframeEffect( + const rabbitDownKeyframes = new KeyframeEffect( whiteRabbit, [ { transform: 'translateY(0%)' }, @@ -74,30 +74,26 @@ function test_whiteRabbit() { ], { duration: 3000, fill: 'forwards' } ); - var rabbitDownAnimation = new Animation(rabbitDownKeyframes, document.timeline); + const rabbitDownAnimation = new Animation(rabbitDownKeyframes, document.timeline); // On tap or click, whiteRabbit.addEventListener("mousedown", downHeGoes, false); whiteRabbit.addEventListener("touchstart", downHeGoes, false); // Trigger a single-fire animation function downHeGoes(event: Event) { - // Remove those event listeners whiteRabbit!.removeEventListener("mousedown", downHeGoes, false); whiteRabbit!.removeEventListener("touchstart", downHeGoes, false); // Play rabbit animation rabbitDownAnimation.play(); - } } - - } // Testing onsample // https://github.com/web-animations/web-animations-js/releases function test_onsample_And_addEventListener() { - var elem = document.createElement("div"); + const elem = document.createElement("div"); if (elem) { elem.style.width = '150px'; elem.style.color = 'black'; @@ -113,9 +109,9 @@ function test_onsample_And_addEventListener() { }; // onsample is write only console.log(myEffect.onsample); // => undefined - var myAnimation = document.timeline.play(myEffect); + const myAnimation = document.timeline.play(myEffect); myAnimation.addEventListener("finish", (e) => { console.log("finished", e); - }) + }); } } diff --git a/types/webappsec-credential-management/index.d.ts b/types/webappsec-credential-management/index.d.ts index 491efb3829..1851eddba7 100644 --- a/types/webappsec-credential-management/index.d.ts +++ b/types/webappsec-credential-management/index.d.ts @@ -109,36 +109,36 @@ interface Body { interface URLSearchParams { /** - * Appends a specified key/value pair as a new search parameter. - */ + * Appends a specified key/value pair as a new search parameter. + */ append(name: string, value: string): void; /** - * Deletes the given search parameter, and its associated value, from the list of all search parameters. - */ + * Deletes the given search parameter, and its associated value, from the list of all search parameters. + */ delete(name: string): void; /** - * Returns the first value associated to the given search parameter. - */ + * Returns the first value associated to the given search parameter. + */ get(name: string): string | null; /** - * Returns all the values association with a given search parameter. - */ + * Returns all the values association with a given search parameter. + */ getAll(name: string): string[]; /** - * Returns a Boolean indicating if such a search parameter exists. - */ + * Returns a Boolean indicating if such a search parameter exists. + */ has(name: string): boolean; /** - * Sets the value associated to a given search parameter to the given value. If there were several values, delete the others. - */ + * Sets the value associated to a given search parameter to the given value. If there were several values, delete the others. + */ set(name: string, value: string): void; } declare var URLSearchParams: { prototype: URLSearchParams; /** - * Constructor returning a URLSearchParams object. - */ + * Constructor returning a URLSearchParams object. + */ new (init?: string | URLSearchParams): URLSearchParams; }; diff --git a/types/webappsec-credential-management/webappsec-credential-management-tests.ts b/types/webappsec-credential-management/webappsec-credential-management-tests.ts index 69cae46daf..148b604a69 100644 --- a/types/webappsec-credential-management/webappsec-credential-management-tests.ts +++ b/types/webappsec-credential-management/webappsec-credential-management-tests.ts @@ -71,7 +71,7 @@ function passwordPostSignInConfirmation() { e.preventDefault(); const formElem = (e.target as HTMLFormElement); - var c = new PasswordCredential(formElem); + const c = new PasswordCredential(formElem); fetch(formElem.action, {method: 'POST', credentials: c}).then(r => { if (r.status === 200) { navigator.credentials!.store(c); @@ -89,13 +89,11 @@ function federationPostSignInConfirmation() { } } - // The change password example from Section 1.2.4 is essentially the same // as in 1.2.4, but the form element has different autocomplete annotations. // Therefore, we don't duplicate it here. // https://www.w3.org/TR/credential-management-1/#examples-change-password - // layering on top of a legacy system examples, from Section 1.2.5 // https://www.w3.org/TR/credential-management-1/#examples-legacy function existingFormPost(credential: PasswordCredential) { diff --git a/types/webgl2/tslint.json b/types/webgl2/tslint.json index 3bcd4abbe9..e9136418da 100644 --- a/types/webgl2/tslint.json +++ b/types/webgl2/tslint.json @@ -2,8 +2,11 @@ "extends": "../tslint.json", "rules": { "dt-header": false, + "align": false, "adjacent-overload-signatures": false, + "comment-format": false, "unified-signatures": false, + "no-consecutive-blank-lines": false, "no-empty-interface": false } } diff --git a/types/webpack-chain/index.d.ts b/types/webpack-chain/index.d.ts index f6cfc40b25..dd7b0b0d63 100644 --- a/types/webpack-chain/index.d.ts +++ b/types/webpack-chain/index.d.ts @@ -9,187 +9,187 @@ import * as https from 'https'; export = Config; declare class Config { - devServer: Config.DevServer - entryPoints: Config.EntryPoints - module: Config.Module - node: Config.ChainedMap - output: Config.Output - performance: Config.Performance - plugins: Config.Plugins - resolve: Config.Resolve - resolveLoader: Config.ResolveLoader + devServer: Config.DevServer; + entryPoints: Config.EntryPoints; + module: Config.Module; + node: Config.ChainedMap; + output: Config.Output; + performance: Config.Performance; + plugins: Config.Plugins; + resolve: Config.Resolve; + resolveLoader: Config.ResolveLoader; - amd(value: { [moduleName: string]: boolean }): this - bail(value: boolean): this - cache(value: boolean | any): this - devtool(value: Config.DevTool): this - context(value: string): this - externals(value: webpack.ExternalsElement | webpack.ExternalsElement[]): this - loader(value: any): this - profile(value: boolean): this - recordsPath(value: string): this - recordsInputPath(value: string): this - recordsOutputPath(value: string): this - stats(value: webpack.Options.Stats): this - target(value: string): this - watch(value: boolean): this - watchOptions(value: webpack.Options.WatchOptions): this + amd(value: { [moduleName: string]: boolean }): this; + bail(value: boolean): this; + cache(value: boolean | any): this; + devtool(value: Config.DevTool): this; + context(value: string): this; + externals(value: webpack.ExternalsElement | webpack.ExternalsElement[]): this; + loader(value: any): this; + profile(value: boolean): this; + recordsPath(value: string): this; + recordsInputPath(value: string): this; + recordsOutputPath(value: string): this; + stats(value: webpack.Options.Stats): this; + target(value: string): this; + watch(value: boolean): this; + watchOptions(value: webpack.Options.WatchOptions): this; - entry(name: string): Config.ChainedSet - plugin(name: string): Config.Plugin + entry(name: string): Config.ChainedSet; + plugin(name: string): Config.Plugin; - toConfig(): webpack.Configuration - merge(obj: any): this + toConfig(): webpack.Configuration; + merge(obj: any): this; } declare namespace Config { - export class Chained { - end(): Parent + class Chained { + end(): Parent; } - export class TypedChainedMap extends Chained { - clear(): this - delete(key: string): this - has(key: string): boolean - get(key: string): Value - set(key: string, value: Value): this - merge(obj: { [key: string]: Value }): this - entries(): { [key: string]: Value } - values(): Array + class TypedChainedMap extends Chained { + clear(): this; + delete(key: string): this; + has(key: string): boolean; + get(key: string): Value; + set(key: string, value: Value): this; + merge(obj: { [key: string]: Value }): this; + entries(): { [key: string]: Value }; + values(): Value[]; } - export class ChainedMap extends TypedChainedMap {} + class ChainedMap extends TypedChainedMap {} - export class TypedChainedSet extends Chained { - add(value: Value): this - prepend(value: Value): this - clear(): this - delete(key: string): this - has(key: string): boolean - merge(arr: Array): this - values(): Array + class TypedChainedSet extends Chained { + add(value: Value): this; + prepend(value: Value): this; + clear(): this; + delete(key: string): this; + has(key: string): boolean; + merge(arr: Value[]): this; + values(): Value[]; } - export class ChainedSet extends TypedChainedSet {} + class ChainedSet extends TypedChainedSet {} - export class Plugins extends TypedChainedMap> {} + class Plugins extends TypedChainedMap> {} - export class Plugin extends ChainedMap { - init(value: (plugin: PluginClass, args: any[]) => webpack.Plugin): this - use(plugin: PluginClass, args?: any[]): this - tap(f: (args: any[]) => any[]): this + class Plugin extends ChainedMap { + init(value: (plugin: PluginClass, args: any[]) => webpack.Plugin): this; + use(plugin: PluginClass, args?: any[]): this; + tap(f: (args: any[]) => any[]): this; } - export class Module extends ChainedMap { - rules: TypedChainedMap - rule(name: string): Rule + class Module extends ChainedMap { + rules: TypedChainedMap; + rule(name: string): Rule; } - export class Output extends ChainedMap { - chunkFilename(value: string): this - crossOriginLoading(value: boolean | string): this - filename(value: string): this - library(value: string): this - libraryTarget(value: string): this - devtoolFallbackModuleFilenameTemplate(value: any): this - devtoolLineToLine(value: any): this - devtoolModuleFilenameTemplate(value: any): this - hashFunction(value: string): this - hashDigest(value: string): this - hashDigestLength(value: number): this - hashSalt(value: any): this - hotUpdateChunkFilename(value: string): this - hotUpdateFunction(value: any): this - hotUpdateMainFilename(value: string): this - jsonpFunction(value: string): this - path(value: string): this - pathinfo(value: boolean): this - publicPath(value: string): this - sourceMapFilename(value: string): this - sourcePrefix(value: string): this - strictModuleExceptionHandling(value: boolean): this - umdNamedDefine(value: boolean): this + class Output extends ChainedMap { + chunkFilename(value: string): this; + crossOriginLoading(value: boolean | string): this; + filename(value: string): this; + library(value: string): this; + libraryTarget(value: string): this; + devtoolFallbackModuleFilenameTemplate(value: any): this; + devtoolLineToLine(value: any): this; + devtoolModuleFilenameTemplate(value: any): this; + hashFunction(value: string): this; + hashDigest(value: string): this; + hashDigestLength(value: number): this; + hashSalt(value: any): this; + hotUpdateChunkFilename(value: string): this; + hotUpdateFunction(value: any): this; + hotUpdateMainFilename(value: string): this; + jsonpFunction(value: string): this; + path(value: string): this; + pathinfo(value: boolean): this; + publicPath(value: string): this; + sourceMapFilename(value: string): this; + sourcePrefix(value: string): this; + strictModuleExceptionHandling(value: boolean): this; + umdNamedDefine(value: boolean): this; } - export class DevServer extends ChainedMap { - clientLogLevel(value: 'none' | 'error' | 'warning' | 'info'): this - compress(value: boolean): this - contentBase(value: boolean | string | string[]): this - filename(value: string): this - headers(value: { [header: string]: string }): this - historyApiFallback(value: boolean | any): this - host(value: string): this - hot(value: boolean): this - hotOnly(value: boolean): this - https(value: boolean | https.ServerOptions): this - inline(value: boolean): this - lazy(value: boolean): this - noInfo(value: boolean): this - overlay(value: boolean | { warnings?: boolean, errors?: boolean }): this - port(value: number): this - proxy(value: any): this - quiet(value: boolean): this - setup(value: (expressApp: any) => void): this - stats(value: webpack.Options.Stats): this - watchContentBase(value: boolean): this + class DevServer extends ChainedMap { + clientLogLevel(value: 'none' | 'error' | 'warning' | 'info'): this; + compress(value: boolean): this; + contentBase(value: boolean | string | string[]): this; + filename(value: string): this; + headers(value: { [header: string]: string }): this; + historyApiFallback(value: boolean | any): this; + host(value: string): this; + hot(value: boolean): this; + hotOnly(value: boolean): this; + https(value: boolean | https.ServerOptions): this; + inline(value: boolean): this; + lazy(value: boolean): this; + noInfo(value: boolean): this; + overlay(value: boolean | { warnings?: boolean, errors?: boolean }): this; + port(value: number): this; + proxy(value: any): this; + quiet(value: boolean): this; + setup(value: (expressApp: any) => void): this; + stats(value: webpack.Options.Stats): this; + watchContentBase(value: boolean): this; } - export class Performance extends ChainedMap { - hints(value: boolean | 'error' | 'warning'): this - maxEntrypointSize(value: number): this - maxAssetSize(value: number): this - assetFilter(value: (assetFilename: string) => boolean): this + class Performance extends ChainedMap { + hints(value: boolean | 'error' | 'warning'): this; + maxEntrypointSize(value: number): this; + maxAssetSize(value: number): this; + assetFilter(value: (assetFilename: string) => boolean): this; } - export class EntryPoints extends TypedChainedMap> {} + class EntryPoints extends TypedChainedMap> {} - export class Resolve extends ChainedMap { - alias: TypedChainedMap - aliasFields: TypedChainedSet - descriptionFiles: TypedChainedSet - extensions: TypedChainedSet - mainFields: TypedChainedSet - mainFiles: TypedChainedSet - modules: TypedChainedSet - plugins: TypedChainedMap> + class Resolve extends ChainedMap { + alias: TypedChainedMap; + aliasFields: TypedChainedSet; + descriptionFiles: TypedChainedSet; + extensions: TypedChainedSet; + mainFields: TypedChainedSet; + mainFiles: TypedChainedSet; + modules: TypedChainedSet; + plugins: TypedChainedMap>; - enforceExtension(value: boolean): this - enforceModuleExtension(value: boolean): this - unsafeCache(value: boolean | RegExp | RegExp[]): this - symlinks(value: boolean): this - cachePredicate(value: (data: { path: string, request: string }) => boolean): this + enforceExtension(value: boolean): this; + enforceModuleExtension(value: boolean): this; + unsafeCache(value: boolean | RegExp | RegExp[]): this; + symlinks(value: boolean): this; + cachePredicate(value: (data: { path: string, request: string }) => boolean): this; - plugin(name: string): Plugin + plugin(name: string): Plugin; } - export class ResolveLoader extends ChainedMap { - extensions: TypedChainedSet - modules: TypedChainedSet - moduleExtensions: TypedChainedSet - packageMains: TypedChainedSet + class ResolveLoader extends ChainedMap { + extensions: TypedChainedSet; + modules: TypedChainedSet; + moduleExtensions: TypedChainedSet; + packageMains: TypedChainedSet; } - export class Rule extends ChainedMap { - uses: TypedChainedMap - include: TypedChainedSet - exclude: TypedChainedSet + class Rule extends ChainedMap { + uses: TypedChainedMap; + include: TypedChainedSet; + exclude: TypedChainedSet; - parser(value: { [optName: string]: any }): this - test(value: webpack.Condition | webpack.Condition[]): this - enforce(value: 'pre' | 'post'): this + parser(value: { [optName: string]: any }): this; + test(value: webpack.Condition | webpack.Condition[]): this; + enforce(value: 'pre' | 'post'): this; - use(name: string): Use - pre(): this - post(): this + use(name: string): Use; + pre(): this; + post(): this; } - type LoaderOptions = { [name: string]: any } + interface LoaderOptions { [name: string]: any; } - export class Use extends ChainedMap { - loader(value: string): this - options(value: LoaderOptions): this + class Use extends ChainedMap { + loader(value: string): this; + options(value: LoaderOptions): this; - tap(f: (options: LoaderOptions) => LoaderOptions): this + tap(f: (options: LoaderOptions) => LoaderOptions): this; } type DevTool = 'eval' | 'inline-source-map' | 'cheap-eval-source-map' | 'cheap-source-map' | @@ -204,9 +204,9 @@ declare namespace Config { '#@eval' | '#@inline-source-map' | '#@cheap-eval-source-map' | '#@cheap-source-map' | '#@cheap-module-eval-source-map' | '#@cheap-module-source-map' | '#@eval-source-map' | '#@source-map' | '#@nosources-source-map' | '#@hidden-source-map' | '#@nosources-source-map' | - boolean + boolean; interface PluginClass { - new (...opts: any[]): webpack.Plugin + new (...opts: any[]): webpack.Plugin; } } diff --git a/types/webpack-chain/webpack-chain-tests.ts b/types/webpack-chain/webpack-chain-tests.ts index da72bc6f9f..f955decd38 100644 --- a/types/webpack-chain/webpack-chain-tests.ts +++ b/types/webpack-chain/webpack-chain-tests.ts @@ -13,7 +13,7 @@ config .context('') .externals('foo') .externals(/node_modules/) - .externals({ 'test': false, 'foo': 'bar' }) + .externals({ test: false, foo: 'bar' }) .externals(['foo', 'bar']) .externals((context, request, cb) => cb(null, true)) .loader({}) diff --git a/types/webpack/index.d.ts b/types/webpack/index.d.ts index 81085d39d8..dfdfb669a1 100644 --- a/types/webpack/index.d.ts +++ b/types/webpack/index.d.ts @@ -262,7 +262,7 @@ declare namespace webpack { * * Defaults to `() => true`. */ - cachePredicate?: (data: { path: string, request: string }) => boolean; + cachePredicate?(data: { path: string, request: string }): boolean; } interface OldResolve { @@ -933,7 +933,6 @@ declare namespace webpack { } namespace loader { - interface Loader extends Function { (this: LoaderContext, source: string | Buffer, sourceMap: string | Buffer): string | Buffer | void | undefined; @@ -968,36 +967,30 @@ declare namespace webpack { */ version: string; - /** * The directory of the module. Can be used as context for resolving other stuff. * In the example: /abc because resource.js is in this directory */ context: string; - /** * The resolved request string. * In the example: "/abc/loader1.js?xyz!/abc/node_modules/loader2/index.js!/abc/resource.js?rrr" */ request: string; - /** * A string or any object. The query of the request for the current loader. */ query: any; - /** * A data object shared between the pitch and the normal phase. */ data?: any; - callback: loaderCallback; - /** * Make this loader async. */ @@ -1076,7 +1069,6 @@ declare namespace webpack { */ exec(code: string, filename: string): any; - /** * Resolve a request like a require expression. * @param context @@ -1092,7 +1084,6 @@ declare namespace webpack { */ resolveSync(context: string, request: string): string; - /** * Adds a file as dependency of the loader result in order to make them watchable. * For example, html-loader uses this technique as it finds src and src-set attributes. @@ -1120,7 +1111,6 @@ declare namespace webpack { */ clearDependencies(): void; - /** * Pass values to the next loader. * If you know what your result exports if executed as module, set this value here (as a only element array). @@ -1153,7 +1143,6 @@ declare namespace webpack { */ sourceMap: boolean; - /** * Target of compilation. Passed from configuration options. * Example values: "web", "node" @@ -1169,7 +1158,6 @@ declare namespace webpack { */ webpack: boolean; - /** * Emit a file. This is webpack-specific. * @param name @@ -1178,7 +1166,6 @@ declare namespace webpack { */ emitFile(name: string, content: Buffer|string, sourceMap: any): void; - /** * Access to the compilation's inputFileSystem property. */ @@ -1194,7 +1181,6 @@ declare namespace webpack { */ _compiler: Compiler; - /** * Hacky access to the Module object being loaded. */ diff --git a/types/webpack/webpack-tests.ts b/types/webpack/webpack-tests.ts index e29df7cefb..d7c4b45007 100644 --- a/types/webpack/webpack-tests.ts +++ b/types/webpack/webpack-tests.ts @@ -230,8 +230,8 @@ rule = { loader: "babel-loader" }; -declare var require: any; -declare var path: any; +declare const require: any; +declare const path: any; configuration = { plugins: [ function(this: webpack.Compiler) { @@ -383,9 +383,9 @@ plugin = new CommonsChunkPlugin({ }); plugin = new webpack.DefinePlugin(definitions); plugin = new webpack.DefinePlugin({ - "VERSION": JSON.stringify("5fa3b9"), - "BROWSER_SUPPORTS_HTML5": true, - "TWO": "1+1", + VERSION: JSON.stringify("5fa3b9"), + BROWSER_SUPPORTS_HTML5: true, + TWO: "1+1", "typeof window": JSON.stringify("object") }); plugin = new webpack.ProvidePlugin(definitions); @@ -437,7 +437,7 @@ webpack({ }); // returns a Compiler instance -var compiler = webpack({ +let compiler = webpack({ // configuration }); @@ -475,8 +475,8 @@ webpack({ }, (err, stats) => { if (err) return handleFatalError(err); - var jsonStats = stats.toJson(); - var jsonStatsWithAllOptions = stats.toJson({ + const jsonStats = stats.toJson(); + const jsonStatsWithAllOptions = stats.toJson({ assets: true, assetsSort: "field", cached: true, @@ -505,13 +505,13 @@ webpack({ successfullyCompiled(); }); -declare var fs: any; +declare const fs: any; compiler = webpack({ }); compiler.outputFileSystem = fs; compiler.run((err, stats) => { // ... - var fileContent = fs.readFileSync("..."); + const fileContent = fs.readFileSync("..."); }); // diff --git a/types/wicg-mediasession/wicg-mediasession-tests.ts b/types/wicg-mediasession/wicg-mediasession-tests.ts index 78731a3222..88ab80afa1 100644 --- a/types/wicg-mediasession/wicg-mediasession-tests.ts +++ b/types/wicg-mediasession/wicg-mediasession-tests.ts @@ -1,4 +1,3 @@ - const tracks: string[] = ['chapter1.mp3', 'chapter2.mp3', 'chapter3.mp3']; let trackId = 0; diff --git a/types/wu/wu-tests.ts b/types/wu/wu-tests.ts index 3c62cdb2d4..90657734e7 100644 --- a/types/wu/wu-tests.ts +++ b/types/wu/wu-tests.ts @@ -1,6 +1,9 @@ // adapted from `cat wu.js/test/* |sed '/= require/d'> wu-tests.ts` -declare var describe: any, it: any, mocha: any, assert: { +declare const describe: any; +declare const it: any; +declare const mocha: any; +declare const assert: { iterable: any; eqSet(expected: Set, actual: Iterable): any; ok: any; diff --git a/types/xml/xml-tests.ts b/types/xml/xml-tests.ts index 7bc3cd61c0..54619959af 100644 --- a/types/xml/xml-tests.ts +++ b/types/xml/xml-tests.ts @@ -7,13 +7,12 @@ interface Tester { same(a: any, b: any): void; plan(id: number): void; ok(a: any): void; -}; +} function test(c: string, f: (t: Tester) => void) { return; } - test('no elements', t => { t.is(xml(), ''); t.is(xml([]), ''); @@ -162,4 +161,4 @@ test('xml declaration options', t => { t.is(xml([{a: 'test'}], {declaration: false}), 'test'); t.is(xml([{a: 'test'}], {declaration: true, indent: '\n'}), '\ntest'); t.is(xml([{a: 'test'}], {}), 'test'); -}); \ No newline at end of file +}); diff --git a/types/xml2json/xml2json-tests.ts b/types/xml2json/xml2json-tests.ts index 409fc5f27e..fd8566ca52 100644 --- a/types/xml2json/xml2json-tests.ts +++ b/types/xml2json/xml2json-tests.ts @@ -1,15 +1,15 @@ import * as parser from 'xml2json'; -var xml = "bar"; +let xml = "bar"; // xml to json -var jsonString: string = parser.toJson(xml); +const jsonString: string = parser.toJson(xml); // json to xml -var xml: string = parser.toXml(jsonString); +xml = parser.toXml(jsonString); // xml to json in object mode and JsonOptions -var jsonObject: {} = parser.toJson(xml, { +const jsonObject: {} = parser.toJson(xml, { object: true, reversible: false, coerce: false, @@ -19,6 +19,6 @@ var jsonObject: {} = parser.toJson(xml, { }); // json to xml with XmlOptions -var xml: string = parser.toXml(jsonObject, { +xml = parser.toXml(jsonObject, { sanitize: true }); diff --git a/types/xmpp__jid/index.d.ts b/types/xmpp__jid/index.d.ts index b132680c72..a7b2e0fe7a 100644 --- a/types/xmpp__jid/index.d.ts +++ b/types/xmpp__jid/index.d.ts @@ -10,14 +10,14 @@ // Remove the `declare module` wrapper. // tslint:disable-next-line no-single-declare-module declare module "@xmpp/jid" { - export function createJID(local: string, domain: string, resource: string): JID; - export function equal(a: JID, b: JID): boolean; - export function is(a: any): boolean; + function createJID(local: string, domain: string, resource: string): JID; + function equal(a: JID, b: JID): boolean; + function is(a: any): boolean; /** * Created by marcneumann on 17.02.17. */ - export class JID { + class JID { local: string; domain: string; resource: string; @@ -30,17 +30,17 @@ declare module "@xmpp/jid" { /** * Convenience method to distinguish users - **/ + */ bare(): JID; /** * Comparison function - **/ + */ equals(other: JID): boolean; /** * http://xmpp.org/rfcs/rfc6122.html#addressing-localpart - **/ + */ setLocal(local: string, escape?: any): void; getLocal(unescape?: any): string; diff --git a/types/xsd-schema-validator/index.d.ts b/types/xsd-schema-validator/index.d.ts index db867b4178..c4fd02e8f5 100644 --- a/types/xsd-schema-validator/index.d.ts +++ b/types/xsd-schema-validator/index.d.ts @@ -9,4 +9,4 @@ export function validateXML(xml: string|NodeJS.ReadableStream|{file: string}, pa valid: boolean; messages: string[]; result: string; -}) => void): void; \ No newline at end of file +}) => void): void; diff --git a/types/xsd-schema-validator/xsd-schema-validator-tests.ts b/types/xsd-schema-validator/xsd-schema-validator-tests.ts index d66148d219..21d8f3d2a4 100644 --- a/types/xsd-schema-validator/xsd-schema-validator-tests.ts +++ b/types/xsd-schema-validator/xsd-schema-validator-tests.ts @@ -1,7 +1,6 @@ import fs = require("fs"); import validator = require("xsd-schema-validator"); - validator.validateXML("", 'resources/foo.xsd', (err, result) => { if (err) { throw err; @@ -12,4 +11,4 @@ validator.validateXML(fs.createReadStream('some.xml'), "schema.xsd", (err) => { }); validator.validateXML({ file: "some.xml" }, "schema.xsd", (err) => { if (err) throw err; -}); \ No newline at end of file +});